Microsoft.Media (preview:2021-11-01)

2025/10/22 • 54 deleted methods

EdgeModules_List (removed)
Description :  List all existing edge module resources, along with their JSON representations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/edgeModules
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$top:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of EdgeModuleEntity items. ,
Required: False ,
}
[
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
edgeModuleId:
{
Description: Internal ID generated for the instance of the Video Analyzer edge module. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
}
,
]
,
@nextLink:
{
Description: A link to the next page of the collection (when the collection contains too many results to return in one response). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeModules_Get (removed)
Description :  Retrieves an existing edge module resource with the given name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/edgeModules/{edgeModuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
edgeModuleName:
{
Description: The Edge Module name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
edgeModuleId:
{
Description: Internal ID generated for the instance of the Video Analyzer edge module. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeModules_CreateOrUpdate (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/edgeModules/{edgeModuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
edgeModuleName:
{
Description: The Edge Module name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
edgeModuleId:
{
Description: Internal ID generated for the instance of the Video Analyzer edge module. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
edgeModuleId:
{
Description: Internal ID generated for the instance of the Video Analyzer edge module. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
edgeModuleId:
{
Description: Internal ID generated for the instance of the Video Analyzer edge module. ,
Format: uuid ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeModules_Delete (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/edgeModules/{edgeModuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
edgeModuleName:
{
Description: The Edge Module name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeModules_ListProvisioningToken (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/edgeModules/{edgeModuleName}/listProvisioningToken
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
edgeModuleName:
{
Description: The Edge Module name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
expirationDate:
{
Description: 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. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
expirationDate:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The token blob to be provided to the Azure Video Analyzer IoT edge module through the Azure IoT Edge module twin properties. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PipelineTopologies_List (removed)
Description :  Retrieves a list of pipeline topologies that have been added to the account, if any, along with their JSON representation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/pipelineTopologies
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: Restricts the set of items returned. ,
Required: False ,
}
string ,
$top:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of PipelineTopology items. ,
Required: False ,
}
[
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
description:
{
Description: An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here. ,
Required: False ,
}
string ,
parameters:
{
Description: List of the topology parameter declarations. Parameters declared here can be referenced throughout the topology nodes through the use of "${PARAMETER_NAME}" string pattern. Parameters can have optional default values and can later be defined in individual instances of the pipeline. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter. ,
Required: True ,
}
string ,
type:
{
Description: Type of the parameter. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the parameter. ,
Required: False ,
}
string ,
default:
{
Description: The default value for the parameter to be used if the pipeline does not specify a value. ,
Required: False ,
}
string ,
}
,
]
,
sources:
{
Description: List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline. ,
Required: True ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
]
,
processors:
{
Description: List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed. ,
Required: False ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
inputs:
{
Description: An array of upstream node references within the topology to be used as inputs for this node. ,
Required: True ,
}
[
{
nodeName:
{
Description: The name of the upstream node in the pipeline which output is used as input of the current node. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
sinks:
{
Description: List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported. ,
Required: True ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
inputs:
{
Description: An array of upstream node references within the topology to be used as inputs for this node. ,
Required: True ,
}
[
{
nodeName:
{
Description: The name of the upstream node in the pipeline which output is used as input of the current node. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
kind:
{
Description: Topology kind. ,
Enum:
{
Live: Live pipeline topology resource. ,
Batch: Batch pipeline topology resource. ,
}
,
Required: True ,
}
enum ,
sku:
{
Description: Describes the properties of a SKU. ,
Required: True ,
}
{
name:
{
Description: The SKU name. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. ,
Enum:
{
Standard: Standard tier. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
@nextLink:
{
Description: A link to the next page of the collection (when the collection contains too many results to return in one response). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PipelineTopologies_Get (removed)
Description :  Retrieves a specific pipeline topology by name. If a topology with that name has been previously created, the call will return the JSON representation of that topology.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/pipelineTopologies/{pipelineTopologyName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
pipelineTopologyName:
{
Description: Pipeline topology unique identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
description:
{
Description: An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here. ,
Required: False ,
}
string ,
parameters:
{
Description: List of the topology parameter declarations. Parameters declared here can be referenced throughout the topology nodes through the use of "${PARAMETER_NAME}" string pattern. Parameters can have optional default values and can later be defined in individual instances of the pipeline. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter. ,
Required: True ,
}
string ,
type:
{
Description: Type of the parameter. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the parameter. ,
Required: False ,
}
string ,
default:
{
Description: The default value for the parameter to be used if the pipeline does not specify a value. ,
Required: False ,
}
string ,
}
,
]
,
sources:
{
Description: List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline. ,
Required: True ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
]
,
processors:
{
Description: List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed. ,
Required: False ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
inputs:
{
Description: An array of upstream node references within the topology to be used as inputs for this node. ,
Required: True ,
}
[
{
nodeName:
{
Description: The name of the upstream node in the pipeline which output is used as input of the current node. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
sinks:
{
Description: List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported. ,
Required: True ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
inputs:
{
Description: An array of upstream node references within the topology to be used as inputs for this node. ,
Required: True ,
}
[
{
nodeName:
{
Description: The name of the upstream node in the pipeline which output is used as input of the current node. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
kind:
{
Description: Topology kind. ,
Enum:
{
Live: Live pipeline topology resource. ,
Batch: Batch pipeline topology resource. ,
}
,
Required: True ,
}
enum ,
sku:
{
Description: Describes the properties of a SKU. ,
Required: True ,
}
{
name:
{
Description: The SKU name. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. ,
Enum:
{
Standard: Standard tier. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PipelineTopologies_CreateOrUpdate (removed)
Description :  Creates a new pipeline topology or updates an existing one, with the given name. A pipeline topology describes the processing steps to be applied when processing content for a particular outcome. The topology should be defined according to the scenario to be achieved and can be reused across many pipeline instances which share the same processing characteristics.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/pipelineTopologies/{pipelineTopologyName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
pipelineTopologyName:
{
Description: Pipeline topology unique identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
description:
{
Description: An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here. ,
Required: False ,
}
string ,
parameters:
{
Description: List of the topology parameter declarations. Parameters declared here can be referenced throughout the topology nodes through the use of "${PARAMETER_NAME}" string pattern. Parameters can have optional default values and can later be defined in individual instances of the pipeline. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter. ,
Required: True ,
}
string ,
type:
{
Description: Type of the parameter. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the parameter. ,
Required: False ,
}
string ,
default:
{
Description: The default value for the parameter to be used if the pipeline does not specify a value. ,
Required: False ,
}
string ,
}
,
]
,
sources:
{
Description: List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline. ,
Required: True ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
]
,
processors:
{
Description: List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed. ,
Required: False ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
inputs:
{
Description: An array of upstream node references within the topology to be used as inputs for this node. ,
Required: True ,
}
[
{
nodeName:
{
Description: The name of the upstream node in the pipeline which output is used as input of the current node. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
sinks:
{
Description: List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported. ,
Required: True ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
inputs:
{
Description: An array of upstream node references within the topology to be used as inputs for this node. ,
Required: True ,
}
[
{
nodeName:
{
Description: The name of the upstream node in the pipeline which output is used as input of the current node. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
kind:
{
Description: Topology kind. ,
Enum:
{
Live: Live pipeline topology resource. ,
Batch: Batch pipeline topology resource. ,
}
,
Required: True ,
}
enum ,
sku:
{
Description: Describes the properties of a SKU. ,
Required: True ,
}
{
name:
{
Description: The SKU name. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. ,
Enum:
{
Standard: Standard tier. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
description:
{
Description: An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here. ,
Required: False ,
}
string ,
parameters:
{
Description: List of the topology parameter declarations. Parameters declared here can be referenced throughout the topology nodes through the use of "${PARAMETER_NAME}" string pattern. Parameters can have optional default values and can later be defined in individual instances of the pipeline. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter. ,
Required: True ,
}
string ,
type:
{
Description: Type of the parameter. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the parameter. ,
Required: False ,
}
string ,
default:
{
Description: The default value for the parameter to be used if the pipeline does not specify a value. ,
Required: False ,
}
string ,
}
,
]
,
sources:
{
Description: List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline. ,
Required: True ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
]
,
processors:
{
Description: List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed. ,
Required: False ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
inputs:
{
Description: An array of upstream node references within the topology to be used as inputs for this node. ,
Required: True ,
}
[
{
nodeName:
{
Description: The name of the upstream node in the pipeline which output is used as input of the current node. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
sinks:
{
Description: List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported. ,
Required: True ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
inputs:
{
Description: An array of upstream node references within the topology to be used as inputs for this node. ,
Required: True ,
}
[
{
nodeName:
{
Description: The name of the upstream node in the pipeline which output is used as input of the current node. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
kind:
{
Description: Topology kind. ,
Enum:
{
Live: Live pipeline topology resource. ,
Batch: Batch pipeline topology resource. ,
}
,
Required: True ,
}
enum ,
sku:
{
Description: Describes the properties of a SKU. ,
Required: True ,
}
{
name:
{
Description: The SKU name. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. ,
Enum:
{
Standard: Standard tier. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
description:
{
Description: An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here. ,
Required: False ,
}
string ,
parameters:
{
Description: List of the topology parameter declarations. Parameters declared here can be referenced throughout the topology nodes through the use of "${PARAMETER_NAME}" string pattern. Parameters can have optional default values and can later be defined in individual instances of the pipeline. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter. ,
Required: True ,
}
string ,
type:
{
Description: Type of the parameter. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the parameter. ,
Required: False ,
}
string ,
default:
{
Description: The default value for the parameter to be used if the pipeline does not specify a value. ,
Required: False ,
}
string ,
}
,
]
,
sources:
{
Description: List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline. ,
Required: True ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
]
,
processors:
{
Description: List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed. ,
Required: False ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
inputs:
{
Description: An array of upstream node references within the topology to be used as inputs for this node. ,
Required: True ,
}
[
{
nodeName:
{
Description: The name of the upstream node in the pipeline which output is used as input of the current node. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
sinks:
{
Description: List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported. ,
Required: True ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
inputs:
{
Description: An array of upstream node references within the topology to be used as inputs for this node. ,
Required: True ,
}
[
{
nodeName:
{
Description: The name of the upstream node in the pipeline which output is used as input of the current node. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
kind:
{
Description: Topology kind. ,
Enum:
{
Live: Live pipeline topology resource. ,
Batch: Batch pipeline topology resource. ,
}
,
Required: True ,
}
enum ,
sku:
{
Description: Describes the properties of a SKU. ,
Required: True ,
}
{
name:
{
Description: The SKU name. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. ,
Enum:
{
Standard: Standard tier. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PipelineTopologies_Delete (removed)
Description :  Deletes a pipeline topology with the given name. This method should be called after all instances of the topology have been stopped and deleted.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/pipelineTopologies/{pipelineTopologyName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
pipelineTopologyName:
{
Description: Pipeline topology unique identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PipelineTopologies_Update (removed)
Description :  Updates an existing pipeline topology with the given name. If the associated live pipelines or pipeline jobs are in active or processing state, respectively, then only the description can be updated. Else, the properties that can be updated include: description, parameter declarations, sources, processors, and sinks.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/pipelineTopologies/{pipelineTopologyName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
pipelineTopologyName:
{
Description: Pipeline topology unique identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
description:
{
Description: An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here. ,
Required: False ,
}
string ,
parameters:
{
Description: List of the topology parameter declarations. Parameters declared here can be referenced throughout the topology nodes through the use of "${PARAMETER_NAME}" string pattern. Parameters can have optional default values and can later be defined in individual instances of the pipeline. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter. ,
Required: True ,
}
string ,
type:
{
Description: Type of the parameter. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the parameter. ,
Required: False ,
}
string ,
default:
{
Description: The default value for the parameter to be used if the pipeline does not specify a value. ,
Required: False ,
}
string ,
}
,
]
,
sources:
{
Description: List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline. ,
Required: False ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
]
,
processors:
{
Description: List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed. ,
Required: False ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
inputs:
{
Description: An array of upstream node references within the topology to be used as inputs for this node. ,
Required: True ,
}
[
{
nodeName:
{
Description: The name of the upstream node in the pipeline which output is used as input of the current node. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
sinks:
{
Description: List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported. ,
Required: False ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
inputs:
{
Description: An array of upstream node references within the topology to be used as inputs for this node. ,
Required: True ,
}
[
{
nodeName:
{
Description: The name of the upstream node in the pipeline which output is used as input of the current node. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
kind:
{
Description: Topology kind. ,
Enum:
{
Live: Live pipeline topology resource. ,
Batch: Batch pipeline topology resource. ,
}
,
Required: False ,
}
enum ,
sku:
{
Description: Describes the properties of a SKU. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. ,
Enum:
{
Standard: Standard tier. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
description:
{
Description: An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here. ,
Required: False ,
}
string ,
parameters:
{
Description: List of the topology parameter declarations. Parameters declared here can be referenced throughout the topology nodes through the use of "${PARAMETER_NAME}" string pattern. Parameters can have optional default values and can later be defined in individual instances of the pipeline. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter. ,
Required: True ,
}
string ,
type:
{
Description: Type of the parameter. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Description of the parameter. ,
Required: False ,
}
string ,
default:
{
Description: The default value for the parameter to be used if the pipeline does not specify a value. ,
Required: False ,
}
string ,
}
,
]
,
sources:
{
Description: List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline. ,
Required: True ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
]
,
processors:
{
Description: List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed. ,
Required: False ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
inputs:
{
Description: An array of upstream node references within the topology to be used as inputs for this node. ,
Required: True ,
}
[
{
nodeName:
{
Description: The name of the upstream node in the pipeline which output is used as input of the current node. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
sinks:
{
Description: List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported. ,
Required: True ,
}
[
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
inputs:
{
Description: An array of upstream node references within the topology to be used as inputs for this node. ,
Required: True ,
}
[
{
nodeName:
{
Description: The name of the upstream node in the pipeline which output is used as input of the current node. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
kind:
{
Description: Topology kind. ,
Enum:
{
Live: Live pipeline topology resource. ,
Batch: Batch pipeline topology resource. ,
}
,
Required: True ,
}
enum ,
sku:
{
Description: Describes the properties of a SKU. ,
Required: True ,
}
{
name:
{
Description: The SKU name. ,
Enum:
{
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. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. ,
Enum:
{
Standard: Standard tier. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LivePipelines_List (removed)
Description :  Retrieves a list of live pipelines that have been created, along with their JSON representations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/livePipelines
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: Restricts the set of items returned. ,
Required: False ,
}
string ,
$top:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of LivePipeline items. ,
Required: False ,
}
[
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
topologyName:
{
Description: The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition. ,
Required: True ,
}
string ,
description:
{
Description: An optional description for the pipeline. ,
Required: False ,
}
string ,
bitrateKbps:
{
Description: Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to see if the camera bitrate is now below the reserved capacity. Doing so will ensure that one 'noisy neighbor' does not affect other live pipelines in your account. ,
Format: int32 ,
Required: True ,
}
integer ,
state:
{
Description: Current state of the pipeline (read-only). ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
parameters:
{
Description: List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter declared in the pipeline topology. ,
Required: True ,
}
string ,
value:
{
Description: Parameter value to be applied on this specific pipeline. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
@nextLink:
{
Description: A link to the next page of the collection (when the collection contains too many results to return in one response). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LivePipelines_Get (removed)
Description :  Retrieves a specific live pipeline by name. If a live pipeline with that name has been previously created, the call will return the JSON representation of that instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/livePipelines/{livePipelineName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
livePipelineName:
{
Description: Live pipeline unique identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
topologyName:
{
Description: The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition. ,
Required: True ,
}
string ,
description:
{
Description: An optional description for the pipeline. ,
Required: False ,
}
string ,
bitrateKbps:
{
Description: Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to see if the camera bitrate is now below the reserved capacity. Doing so will ensure that one 'noisy neighbor' does not affect other live pipelines in your account. ,
Format: int32 ,
Required: True ,
}
integer ,
state:
{
Description: Current state of the pipeline (read-only). ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
parameters:
{
Description: List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter declared in the pipeline topology. ,
Required: True ,
}
string ,
value:
{
Description: Parameter value to be applied on this specific pipeline. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LivePipelines_CreateOrUpdate (removed)
Description :  Creates a new live pipeline or updates an existing one, with the given name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/livePipelines/{livePipelineName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
livePipelineName:
{
Description: Live pipeline unique identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
topologyName:
{
Description: The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition. ,
Required: True ,
}
string ,
description:
{
Description: An optional description for the pipeline. ,
Required: False ,
}
string ,
bitrateKbps:
{
Description: Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to see if the camera bitrate is now below the reserved capacity. Doing so will ensure that one 'noisy neighbor' does not affect other live pipelines in your account. ,
Format: int32 ,
Required: True ,
}
integer ,
state:
{
Description: Current state of the pipeline (read-only). ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
parameters:
{
Description: List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter declared in the pipeline topology. ,
Required: True ,
}
string ,
value:
{
Description: Parameter value to be applied on this specific pipeline. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
topologyName:
{
Description: The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition. ,
Required: True ,
}
string ,
description:
{
Description: An optional description for the pipeline. ,
Required: False ,
}
string ,
bitrateKbps:
{
Description: Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to see if the camera bitrate is now below the reserved capacity. Doing so will ensure that one 'noisy neighbor' does not affect other live pipelines in your account. ,
Format: int32 ,
Required: True ,
}
integer ,
state:
{
Description: Current state of the pipeline (read-only). ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
parameters:
{
Description: List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter declared in the pipeline topology. ,
Required: True ,
}
string ,
value:
{
Description: Parameter value to be applied on this specific pipeline. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
topologyName:
{
Description: The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition. ,
Required: True ,
}
string ,
description:
{
Description: An optional description for the pipeline. ,
Required: False ,
}
string ,
bitrateKbps:
{
Description: Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to see if the camera bitrate is now below the reserved capacity. Doing so will ensure that one 'noisy neighbor' does not affect other live pipelines in your account. ,
Format: int32 ,
Required: True ,
}
integer ,
state:
{
Description: Current state of the pipeline (read-only). ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
parameters:
{
Description: List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter declared in the pipeline topology. ,
Required: True ,
}
string ,
value:
{
Description: Parameter value to be applied on this specific pipeline. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LivePipelines_Delete (removed)
Description :  Deletes a live pipeline with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/livePipelines/{livePipelineName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
livePipelineName:
{
Description: Live pipeline unique identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LivePipelines_Update (removed)
Description :  Updates an existing live pipeline with the given name. Properties that can be updated include: description, bitrateKbps, and parameter definitions. Only the description can be updated while the live pipeline is active.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/livePipelines/{livePipelineName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
livePipelineName:
{
Description: Live pipeline unique identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
topologyName:
{
Description: The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition. ,
Required: False ,
}
string ,
description:
{
Description: An optional description for the pipeline. ,
Required: False ,
}
string ,
bitrateKbps:
{
Description: Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to see if the camera bitrate is now below the reserved capacity. Doing so will ensure that one 'noisy neighbor' does not affect other live pipelines in your account. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: Current state of the pipeline (read-only). ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
parameters:
{
Description: List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter declared in the pipeline topology. ,
Required: True ,
}
string ,
value:
{
Description: Parameter value to be applied on this specific pipeline. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
topologyName:
{
Description: The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition. ,
Required: True ,
}
string ,
description:
{
Description: An optional description for the pipeline. ,
Required: False ,
}
string ,
bitrateKbps:
{
Description: Maximum bitrate capacity in Kbps reserved for the live pipeline. The allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP camera exceeds this capacity, then the service will disconnect temporarily from the camera. It will retry to re-establish connection (with exponential backoff), checking to see if the camera bitrate is now below the reserved capacity. Doing so will ensure that one 'noisy neighbor' does not affect other live pipelines in your account. ,
Format: int32 ,
Required: True ,
}
integer ,
state:
{
Description: Current state of the pipeline (read-only). ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
parameters:
{
Description: List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter declared in the pipeline topology. ,
Required: True ,
}
string ,
value:
{
Description: Parameter value to be applied on this specific pipeline. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LivePipelines_Activate (removed)
Description :  Activates a live pipeline with the given name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/livePipelines/{livePipelineName}/activate
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
livePipelineName:
{
Description: Live pipeline unique identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LivePipelines_Deactivate (removed)
Description :  Deactivates a live pipeline with the given name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/livePipelines/{livePipelineName}/deactivate
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
livePipelineName:
{
Description: Live pipeline unique identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PipelineJobs_List (removed)
Description :  Retrieves a list of all live pipelines that have been created, along with their JSON representations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/pipelineJobs
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: Restricts the set of items returned. ,
Required: False ,
}
string ,
$top:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of PipelineJob items. ,
Required: False ,
}
[
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
topologyName:
{
Description: Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition. ,
Required: True ,
}
string ,
description:
{
Description: An optional description for the pipeline. ,
Required: False ,
}
string ,
state:
{
Description: Current state of the pipeline (read-only). ,
Enum:
{
Processing: Pipeline job is processing. ,
Canceled: Pipeline job is canceled. ,
Completed: Pipeline job completed. ,
Failed: Pipeline job failed. ,
}
,
Required: False ,
}
enum ,
expiration:
{
Description: The date-time by when this pipeline job will be automatically deleted from your account. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Details about the error, in case the pipeline job fails. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter declared in the pipeline topology. ,
Required: True ,
}
string ,
value:
{
Description: Parameter value to be applied on this specific pipeline. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
@nextLink:
{
Description: A link to the next page of the collection (when the collection contains too many results to return in one response). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PipelineJobs_Get (removed)
Description :  Retrieves a specific pipeline job by name. If a pipeline job with that name has been previously created, the call will return the JSON representation of that instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/pipelineJobs/{pipelineJobName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
pipelineJobName:
{
Description: The pipeline job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
topologyName:
{
Description: Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition. ,
Required: True ,
}
string ,
description:
{
Description: An optional description for the pipeline. ,
Required: False ,
}
string ,
state:
{
Description: Current state of the pipeline (read-only). ,
Enum:
{
Processing: Pipeline job is processing. ,
Canceled: Pipeline job is canceled. ,
Completed: Pipeline job completed. ,
Failed: Pipeline job failed. ,
}
,
Required: False ,
}
enum ,
expiration:
{
Description: The date-time by when this pipeline job will be automatically deleted from your account. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Details about the error, in case the pipeline job fails. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter declared in the pipeline topology. ,
Required: True ,
}
string ,
value:
{
Description: Parameter value to be applied on this specific pipeline. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PipelineJobs_CreateOrUpdate (removed)
Description :  Creates a new pipeline job or updates an existing one, with the given name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/pipelineJobs/{pipelineJobName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
pipelineJobName:
{
Description: The pipeline job name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
topologyName:
{
Description: Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition. ,
Required: True ,
}
string ,
description:
{
Description: An optional description for the pipeline. ,
Required: False ,
}
string ,
state:
{
Description: Current state of the pipeline (read-only). ,
Enum:
{
Processing: Pipeline job is processing. ,
Canceled: Pipeline job is canceled. ,
Completed: Pipeline job completed. ,
Failed: Pipeline job failed. ,
}
,
Required: False ,
}
enum ,
expiration:
{
Description: The date-time by when this pipeline job will be automatically deleted from your account. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Details about the error, in case the pipeline job fails. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter declared in the pipeline topology. ,
Required: True ,
}
string ,
value:
{
Description: Parameter value to be applied on this specific pipeline. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
topologyName:
{
Description: Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition. ,
Required: True ,
}
string ,
description:
{
Description: An optional description for the pipeline. ,
Required: False ,
}
string ,
state:
{
Description: Current state of the pipeline (read-only). ,
Enum:
{
Processing: Pipeline job is processing. ,
Canceled: Pipeline job is canceled. ,
Completed: Pipeline job completed. ,
Failed: Pipeline job failed. ,
}
,
Required: False ,
}
enum ,
expiration:
{
Description: The date-time by when this pipeline job will be automatically deleted from your account. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Details about the error, in case the pipeline job fails. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter declared in the pipeline topology. ,
Required: True ,
}
string ,
value:
{
Description: Parameter value to be applied on this specific pipeline. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
topologyName:
{
Description: Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition. ,
Required: True ,
}
string ,
description:
{
Description: An optional description for the pipeline. ,
Required: False ,
}
string ,
state:
{
Description: Current state of the pipeline (read-only). ,
Enum:
{
Processing: Pipeline job is processing. ,
Canceled: Pipeline job is canceled. ,
Completed: Pipeline job completed. ,
Failed: Pipeline job failed. ,
}
,
Required: False ,
}
enum ,
expiration:
{
Description: The date-time by when this pipeline job will be automatically deleted from your account. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Details about the error, in case the pipeline job fails. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter declared in the pipeline topology. ,
Required: True ,
}
string ,
value:
{
Description: Parameter value to be applied on this specific pipeline. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PipelineJobs_Delete (removed)
Description :  Deletes a pipeline job with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/pipelineJobs/{pipelineJobName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
pipelineJobName:
{
Description: The pipeline job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PipelineJobs_Update (removed)
Description :  Updates an existing pipeline job with the given name. Properties that can be updated include: description.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/pipelineJobs/{pipelineJobName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
pipelineJobName:
{
Description: The pipeline job name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
topologyName:
{
Description: Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition. ,
Required: False ,
}
string ,
description:
{
Description: An optional description for the pipeline. ,
Required: False ,
}
string ,
state:
{
Description: Current state of the pipeline (read-only). ,
Enum:
{
Processing: Pipeline job is processing. ,
Canceled: Pipeline job is canceled. ,
Completed: Pipeline job completed. ,
Failed: Pipeline job failed. ,
}
,
Required: False ,
}
enum ,
expiration:
{
Description: The date-time by when this pipeline job will be automatically deleted from your account. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Details about the error, in case the pipeline job fails. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter declared in the pipeline topology. ,
Required: True ,
}
string ,
value:
{
Description: Parameter value to be applied on this specific pipeline. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
topologyName:
{
Description: Reference to an existing pipeline topology. When activated, this pipeline job will process content according to the pipeline topology definition. ,
Required: True ,
}
string ,
description:
{
Description: An optional description for the pipeline. ,
Required: False ,
}
string ,
state:
{
Description: Current state of the pipeline (read-only). ,
Enum:
{
Processing: Pipeline job is processing. ,
Canceled: Pipeline job is canceled. ,
Completed: Pipeline job completed. ,
Failed: Pipeline job failed. ,
}
,
Required: False ,
}
enum ,
expiration:
{
Description: The date-time by when this pipeline job will be automatically deleted from your account. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Details about the error, in case the pipeline job fails. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden. ,
Required: False ,
}
[
{
name:
{
Description: Name of the parameter declared in the pipeline topology. ,
Required: True ,
}
string ,
value:
{
Description: Parameter value to be applied on this specific pipeline. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PipelineJobs_Cancel (removed)
Description :  Cancels a pipeline job with the given name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/pipelineJobs/{pipelineJobName}/cancel
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
pipelineJobName:
{
Description: The pipeline job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LivePipelineOperationStatuses_Get (removed)
Description :  Get the operation status of a live pipeline.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/livePipelines/{livePipelineName}/operationStatuses/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
livePipelineName:
{
Description: Live pipeline unique identifier. ,
Required: True ,
}
string ,
operationId:
{
Description: The operation ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the live pipeline operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the live pipeline operation. ,
Required: False ,
}
string ,
error:
{
Description: The error details for the live pipeline operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PipelineJobOperationStatuses_Get (removed)
Description :  Get the operation status of a pipeline job with the given operationId.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/pipelineJobs/{pipelineJobName}/operationStatuses/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
pipelineJobName:
{
Description: The pipeline job name. ,
Required: True ,
}
string ,
operationId:
{
Description: The operation ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the pipeline job operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the pipeline job operation. ,
Required: False ,
}
string ,
error:
{
Description: The error details for the pipeline job operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Lists all the Media operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Media/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of Operation items. ,
Required: False ,
}
[
{
name:
{
Description: The operation name. ,
Required: True ,
}
string ,
display:
{
Description: The operation display name. ,
Required: False ,
}
{
provider:
{
Description: The service provider. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: The operation type. ,
Required: False ,
}
string ,
description:
{
Description: The operation description. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation. ,
Required: False ,
}
string ,
properties:
{
Description: Operation properties format. ,
Required: False ,
}
{
serviceSpecification:
{
Description: The service specifications. ,
Required: False ,
}
{
logSpecifications:
{
Description: List of log specifications. ,
Required: False ,
}
[
{
name:
{
Description: The diagnostic log category name. ,
Required: False ,
}
string ,
displayName:
{
Description: The diagnostic log category display name. ,
Required: False ,
}
string ,
blobDuration:
{
Description: The time range for requests in each blob. ,
Required: False ,
}
string ,
}
,
]
,
metricSpecifications:
{
Description: List of metric specifications. ,
Required: False ,
}
[
{
name:
{
Description: The metric name. ,
Required: False ,
}
string ,
displayName:
{
Description: The metric display name. ,
Required: False ,
}
string ,
displayDescription:
{
Description: The metric display description. ,
Required: False ,
}
string ,
unit:
{
Description: The metric unit ,
Enum:
{
Bytes: The number of bytes. ,
Count: The count. ,
Milliseconds: The number of milliseconds. ,
}
,
Required: False ,
}
enum ,
aggregationType:
{
Description: The metric aggregation type ,
Enum:
{
Average: The average. ,
Count: The count of a number of items, usually requests. ,
Total: The sum. ,
}
,
Required: False ,
}
enum ,
lockAggregationType:
{
Description: The metric lock aggregation type ,
Enum:
{
Average: The average. ,
Count: The count of a number of items, usually requests. ,
Total: The sum. ,
}
,
Required: False ,
}
enum ,
supportedAggregationTypes:
{
Description: Supported aggregation types. ,
Required: False ,
}
[
string ,
]
,
dimensions:
{
Description: The metric dimensions. ,
Required: False ,
}
[
{
name:
{
Description: The metric dimension name. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the dimension. ,
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Description: Whether to export metric to shoebox. ,
Required: False ,
}
boolean ,
}
,
]
,
enableRegionalMdmAccount:
{
Description: Indicates whether regional MDM account is enabled. ,
Required: False ,
}
boolean ,
sourceMdmAccount:
{
Description: The source MDM account. ,
Required: False ,
}
string ,
sourceMdmNamespace:
{
Description: The source MDM namespace. ,
Required: False ,
}
string ,
supportedTimeGrainTypes:
{
Description: The supported time grain types. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
isDataAction:
{
Description: Whether the operation applies to data-plane. ,
Required: False ,
}
boolean ,
actionType:
{
Description: Indicates the action type. ,
Enum:
{
Internal: An internal action. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VideoAnalyzers_List (removed)
Description :  Lists the Video Analyzer accounts in the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of VideoAnalyzer items. ,
Required: False ,
}
[
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
storageAccounts:
{
Description: The storage accounts for this resource. ,
Required: True ,
}
[
{
id:
{
Description: 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). ,
Required: True ,
}
string ,
identity:
{
Description: A managed identity that Video Analyzer will use to access the storage account. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the storage account mapping. ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: The endpoints associated with this resource. ,
Required: False ,
}
[
{
endpointUrl:
{
Description: The URL of the endpoint. ,
Required: False ,
}
string ,
type:
{
Description: The type of the endpoint. ,
Enum:
{
ClientApi: The client API endpoint. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
encryption:
{
Description: The account encryption properties. ,
Required: False ,
}
{
type:
{
Description: The type of key used to encrypt the Account Key. ,
Enum:
{
SystemKey: The Account Key is encrypted with a System Key. ,
CustomerKey: The Account Key is encrypted with a Customer Key. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the key used to encrypt the account. ,
Required: False ,
}
{
keyIdentifier:
{
Description: 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). ,
Required: True ,
}
string ,
currentKeyIdentifier:
{
Description: The current key used to encrypt Video Analyzer account, including the key version. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The Key Vault identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the Key Vault mapping. ,
Required: False ,
}
string ,
}
,
iotHubs:
{
Description: The IoT Hubs for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The IoT Hub resource identifier. ,
Required: True ,
}
string ,
identity:
{
Description: The IoT Hub identity. ,
Required: True ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the Iot Hub mapping. ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
networkAccessControl:
{
Description: Network access control for Video Analyzer. ,
Required: False ,
}
{
integration:
{
Description: Public network access for integration group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
ingestion:
{
Description: Public network access for ingestion group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
consumption:
{
Description: Public network access for consumption group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the Video Analyzer account. ,
Enum:
{
Failed: Provisioning state failed. ,
InProgress: Provisioning state in progress. ,
Succeeded: Provisioning state succeeded. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Private Endpoint Connections created under Video Analyzer account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
identity:
{
Description: The identities associated to the Video Analyzer resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Required: True ,
}
string ,
userAssignedIdentities:
{
Description: The User Assigned Managed Identities. ,
Required: False ,
}
object ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VideoAnalyzers_Get (removed)
Description :  Get the details of the specified Video Analyzer account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Video Analyzer account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
storageAccounts:
{
Description: The storage accounts for this resource. ,
Required: True ,
}
[
{
id:
{
Description: 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). ,
Required: True ,
}
string ,
identity:
{
Description: A managed identity that Video Analyzer will use to access the storage account. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the storage account mapping. ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: The endpoints associated with this resource. ,
Required: False ,
}
[
{
endpointUrl:
{
Description: The URL of the endpoint. ,
Required: False ,
}
string ,
type:
{
Description: The type of the endpoint. ,
Enum:
{
ClientApi: The client API endpoint. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
encryption:
{
Description: The account encryption properties. ,
Required: False ,
}
{
type:
{
Description: The type of key used to encrypt the Account Key. ,
Enum:
{
SystemKey: The Account Key is encrypted with a System Key. ,
CustomerKey: The Account Key is encrypted with a Customer Key. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the key used to encrypt the account. ,
Required: False ,
}
{
keyIdentifier:
{
Description: 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). ,
Required: True ,
}
string ,
currentKeyIdentifier:
{
Description: The current key used to encrypt Video Analyzer account, including the key version. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The Key Vault identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the Key Vault mapping. ,
Required: False ,
}
string ,
}
,
iotHubs:
{
Description: The IoT Hubs for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The IoT Hub resource identifier. ,
Required: True ,
}
string ,
identity:
{
Description: The IoT Hub identity. ,
Required: True ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the Iot Hub mapping. ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
networkAccessControl:
{
Description: Network access control for Video Analyzer. ,
Required: False ,
}
{
integration:
{
Description: Public network access for integration group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
ingestion:
{
Description: Public network access for ingestion group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
consumption:
{
Description: Public network access for consumption group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the Video Analyzer account. ,
Enum:
{
Failed: Provisioning state failed. ,
InProgress: Provisioning state in progress. ,
Succeeded: Provisioning state succeeded. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Private Endpoint Connections created under Video Analyzer account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
identity:
{
Description: The identities associated to the Video Analyzer resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Required: True ,
}
string ,
userAssignedIdentities:
{
Description: The User Assigned Managed Identities. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VideoAnalyzers_CreateOrUpdate (removed)
Description :  Create or update an instance of a Video Analyzer account
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Video Analyzer account name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
storageAccounts:
{
Description: The storage accounts for this resource. ,
Required: True ,
}
[
{
id:
{
Description: 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). ,
Required: True ,
}
string ,
identity:
{
Description: A managed identity that Video Analyzer will use to access the storage account. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the storage account mapping. ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: The endpoints associated with this resource. ,
Required: False ,
}
[
{
endpointUrl:
{
Description: The URL of the endpoint. ,
Required: False ,
}
string ,
type:
{
Description: The type of the endpoint. ,
Enum:
{
ClientApi: The client API endpoint. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
encryption:
{
Description: The account encryption properties. ,
Required: False ,
}
{
type:
{
Description: The type of key used to encrypt the Account Key. ,
Enum:
{
SystemKey: The Account Key is encrypted with a System Key. ,
CustomerKey: The Account Key is encrypted with a Customer Key. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the key used to encrypt the account. ,
Required: False ,
}
{
keyIdentifier:
{
Description: 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). ,
Required: True ,
}
string ,
currentKeyIdentifier:
{
Description: The current key used to encrypt Video Analyzer account, including the key version. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The Key Vault identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the Key Vault mapping. ,
Required: False ,
}
string ,
}
,
iotHubs:
{
Description: The IoT Hubs for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The IoT Hub resource identifier. ,
Required: True ,
}
string ,
identity:
{
Description: The IoT Hub identity. ,
Required: True ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the Iot Hub mapping. ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
networkAccessControl:
{
Description: Network access control for Video Analyzer. ,
Required: False ,
}
{
integration:
{
Description: Public network access for integration group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
ingestion:
{
Description: Public network access for ingestion group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
consumption:
{
Description: Public network access for consumption group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the Video Analyzer account. ,
Enum:
{
Failed: Provisioning state failed. ,
InProgress: Provisioning state in progress. ,
Succeeded: Provisioning state succeeded. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Private Endpoint Connections created under Video Analyzer account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
identity:
{
Description: The identities associated to the Video Analyzer resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Required: True ,
}
string ,
userAssignedIdentities:
{
Description: The User Assigned Managed Identities. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
storageAccounts:
{
Description: The storage accounts for this resource. ,
Required: True ,
}
[
{
id:
{
Description: 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). ,
Required: True ,
}
string ,
identity:
{
Description: A managed identity that Video Analyzer will use to access the storage account. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the storage account mapping. ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: The endpoints associated with this resource. ,
Required: False ,
}
[
{
endpointUrl:
{
Description: The URL of the endpoint. ,
Required: False ,
}
string ,
type:
{
Description: The type of the endpoint. ,
Enum:
{
ClientApi: The client API endpoint. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
encryption:
{
Description: The account encryption properties. ,
Required: False ,
}
{
type:
{
Description: The type of key used to encrypt the Account Key. ,
Enum:
{
SystemKey: The Account Key is encrypted with a System Key. ,
CustomerKey: The Account Key is encrypted with a Customer Key. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the key used to encrypt the account. ,
Required: False ,
}
{
keyIdentifier:
{
Description: 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). ,
Required: True ,
}
string ,
currentKeyIdentifier:
{
Description: The current key used to encrypt Video Analyzer account, including the key version. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The Key Vault identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the Key Vault mapping. ,
Required: False ,
}
string ,
}
,
iotHubs:
{
Description: The IoT Hubs for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The IoT Hub resource identifier. ,
Required: True ,
}
string ,
identity:
{
Description: The IoT Hub identity. ,
Required: True ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the Iot Hub mapping. ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
networkAccessControl:
{
Description: Network access control for Video Analyzer. ,
Required: False ,
}
{
integration:
{
Description: Public network access for integration group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
ingestion:
{
Description: Public network access for ingestion group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
consumption:
{
Description: Public network access for consumption group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the Video Analyzer account. ,
Enum:
{
Failed: Provisioning state failed. ,
InProgress: Provisioning state in progress. ,
Succeeded: Provisioning state succeeded. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Private Endpoint Connections created under Video Analyzer account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
identity:
{
Description: The identities associated to the Video Analyzer resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Required: True ,
}
string ,
userAssignedIdentities:
{
Description: The User Assigned Managed Identities. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
location:
{
Description: The URI to poll for completion status. ,
}
string ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}
,
$schema:
{
Description: The Video Analyzer account. ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
storageAccounts:
{
Description: The storage accounts for this resource. ,
Required: True ,
}
[
{
id:
{
Description: 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). ,
Required: True ,
}
string ,
identity:
{
Description: A managed identity that Video Analyzer will use to access the storage account. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the storage account mapping. ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: The endpoints associated with this resource. ,
Required: False ,
}
[
{
endpointUrl:
{
Description: The URL of the endpoint. ,
Required: False ,
}
string ,
type:
{
Description: The type of the endpoint. ,
Enum:
{
ClientApi: The client API endpoint. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
encryption:
{
Description: The account encryption properties. ,
Required: False ,
}
{
type:
{
Description: The type of key used to encrypt the Account Key. ,
Enum:
{
SystemKey: The Account Key is encrypted with a System Key. ,
CustomerKey: The Account Key is encrypted with a Customer Key. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the key used to encrypt the account. ,
Required: False ,
}
{
keyIdentifier:
{
Description: 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). ,
Required: True ,
}
string ,
currentKeyIdentifier:
{
Description: The current key used to encrypt Video Analyzer account, including the key version. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The Key Vault identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the Key Vault mapping. ,
Required: False ,
}
string ,
}
,
iotHubs:
{
Description: The IoT Hubs for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The IoT Hub resource identifier. ,
Required: True ,
}
string ,
identity:
{
Description: The IoT Hub identity. ,
Required: True ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the Iot Hub mapping. ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
networkAccessControl:
{
Description: Network access control for Video Analyzer. ,
Required: False ,
}
{
integration:
{
Description: Public network access for integration group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
ingestion:
{
Description: Public network access for ingestion group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
consumption:
{
Description: Public network access for consumption group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the Video Analyzer account. ,
Enum:
{
Failed: Provisioning state failed. ,
InProgress: Provisioning state in progress. ,
Succeeded: Provisioning state succeeded. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Private Endpoint Connections created under Video Analyzer account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
identity:
{
Description: The identities associated to the Video Analyzer resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Required: True ,
}
string ,
userAssignedIdentities:
{
Description: The User Assigned Managed Identities. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VideoAnalyzers_Delete (removed)
Description :  Delete the specified Video Analyzer account
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Video Analyzer account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VideoAnalyzers_Update (removed)
Description :  Updates an existing instance of Video Analyzer account
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Video Analyzer account name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
storageAccounts:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
id:
{
Description: 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). ,
Required: True ,
}
string ,
identity:
{
Description: A managed identity that Video Analyzer will use to access the storage account. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the storage account mapping. ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: The endpoints associated with this resource. ,
Required: False ,
}
[
{
endpointUrl:
{
Description: The URL of the endpoint. ,
Required: False ,
}
string ,
type:
{
Description: The type of the endpoint. ,
Enum:
{
ClientApi: The client API endpoint. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
encryption:
{
Description: The account encryption properties. ,
Required: False ,
}
{
type:
{
Description: The type of key used to encrypt the Account Key. ,
Enum:
{
SystemKey: The Account Key is encrypted with a System Key. ,
CustomerKey: The Account Key is encrypted with a Customer Key. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the key used to encrypt the account. ,
Required: False ,
}
{
keyIdentifier:
{
Description: 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). ,
Required: True ,
}
string ,
currentKeyIdentifier:
{
Description: The current key used to encrypt Video Analyzer account, including the key version. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The Key Vault identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the Key Vault mapping. ,
Required: False ,
}
string ,
}
,
iotHubs:
{
Description: The IoT Hubs for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The IoT Hub resource identifier. ,
Required: True ,
}
string ,
identity:
{
Description: The IoT Hub identity. ,
Required: True ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the Iot Hub mapping. ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
networkAccessControl:
{
Description: Network access control for Video Analyzer. ,
Required: False ,
}
{
integration:
{
Description: Public network access for integration group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
ingestion:
{
Description: Public network access for ingestion group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
consumption:
{
Description: Public network access for consumption group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the Video Analyzer account. ,
Enum:
{
Failed: Provisioning state failed. ,
InProgress: Provisioning state in progress. ,
Succeeded: Provisioning state succeeded. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Private Endpoint Connections created under Video Analyzer account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
identity:
{
Description: The identities associated to the Video Analyzer resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Required: True ,
}
string ,
userAssignedIdentities:
{
Description: The User Assigned Managed Identities. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
location:
{
Description: The URI to poll for completion status. ,
}
string ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}
,
$schema:
{
Description: The Video Analyzer account. ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
storageAccounts:
{
Description: The storage accounts for this resource. ,
Required: True ,
}
[
{
id:
{
Description: 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). ,
Required: True ,
}
string ,
identity:
{
Description: A managed identity that Video Analyzer will use to access the storage account. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the storage account mapping. ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: The endpoints associated with this resource. ,
Required: False ,
}
[
{
endpointUrl:
{
Description: The URL of the endpoint. ,
Required: False ,
}
string ,
type:
{
Description: The type of the endpoint. ,
Enum:
{
ClientApi: The client API endpoint. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
encryption:
{
Description: The account encryption properties. ,
Required: False ,
}
{
type:
{
Description: The type of key used to encrypt the Account Key. ,
Enum:
{
SystemKey: The Account Key is encrypted with a System Key. ,
CustomerKey: The Account Key is encrypted with a Customer Key. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the key used to encrypt the account. ,
Required: False ,
}
{
keyIdentifier:
{
Description: 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). ,
Required: True ,
}
string ,
currentKeyIdentifier:
{
Description: The current key used to encrypt Video Analyzer account, including the key version. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The Key Vault identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the Key Vault mapping. ,
Required: False ,
}
string ,
}
,
iotHubs:
{
Description: The IoT Hubs for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The IoT Hub resource identifier. ,
Required: True ,
}
string ,
identity:
{
Description: The IoT Hub identity. ,
Required: True ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the Iot Hub mapping. ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
networkAccessControl:
{
Description: Network access control for Video Analyzer. ,
Required: False ,
}
{
integration:
{
Description: Public network access for integration group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
ingestion:
{
Description: Public network access for ingestion group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
consumption:
{
Description: Public network access for consumption group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the Video Analyzer account. ,
Enum:
{
Failed: Provisioning state failed. ,
InProgress: Provisioning state in progress. ,
Succeeded: Provisioning state succeeded. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Private Endpoint Connections created under Video Analyzer account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
identity:
{
Description: The identities associated to the Video Analyzer resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Required: True ,
}
string ,
userAssignedIdentities:
{
Description: The User Assigned Managed Identities. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_List (removed)
Description :  Get list of group IDs for video analyzer account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/privateLinkResources
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Video Analyzer account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (removed)
Description :  Get group ID for video analyzer account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/privateLinkResources/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Video Analyzer account name. ,
Required: True ,
}
string ,
name:
{
Description: Name of the private link resource (Group ID). ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (removed)
Description :  Get all private endpoint connections under video analyzer account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/privateEndpointConnections
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Video Analyzer account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (removed)
Description :  Get private endpoint connection under video analyzer account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/privateEndpointConnections/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Video Analyzer account name. ,
Required: True ,
}
string ,
name:
{
Description: Private endpoint connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (removed)
Description :  Update private endpoint connection state under video analyzer account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/privateEndpointConnections/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Video Analyzer account name. ,
Required: True ,
}
string ,
name:
{
Description: Private endpoint connection name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation. ,
}
integer ,
location:
{
Description: The URI to poll for completion status. ,
}
string ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}
,
$schema:
{
Description: The Private Endpoint Connection resource. ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (removed)
Description :  Delete private endpoint connection under video analyzer account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/privateEndpointConnections/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Video Analyzer account name. ,
Required: True ,
}
string ,
name:
{
Description: Private endpoint connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OperationStatuses_Get (removed)
Description :  Get private endpoint connection operation status.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/privateEndpointConnections/{name}/operationStatuses/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Video Analyzer account name. ,
Required: True ,
}
string ,
name:
{
Description: Private endpoint connection name. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Operation identifier. ,
Required: True ,
}
string ,
id:
{
Description: Operation resource ID. ,
Required: False ,
}
string ,
startTime:
{
Description: Operation start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Operation end time. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: False ,
}
string ,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OperationResults_Get (removed)
Description :  Get private endpoint connection operation result.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/privateEndpointConnections/{name}/operationResults/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Video Analyzer account name. ,
Required: True ,
}
string ,
name:
{
Description: Private endpoint connection name. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VideoAnalyzerOperationStatuses_Get (removed)
Description :  Get video analyzer operation status.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Media/locations/{locationName}/videoAnalyzerOperationStatuses/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
locationName:
{
Description: Location name. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Operation identifier. ,
Required: True ,
}
string ,
id:
{
Description: Operation resource ID. ,
Required: False ,
}
string ,
startTime:
{
Description: Operation start time. ,
Required: False ,
}
string ,
endTime:
{
Description: Operation end time. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: False ,
}
string ,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VideoAnalyzerOperationResults_Get (removed)
Description :  Get video analyzer operation result.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Media/locations/{locationName}/videoAnalyzerOperationResults/{operationId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
locationName:
{
Description: Location name. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
storageAccounts:
{
Description: The storage accounts for this resource. ,
Required: True ,
}
[
{
id:
{
Description: 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). ,
Required: True ,
}
string ,
identity:
{
Description: A managed identity that Video Analyzer will use to access the storage account. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the storage account mapping. ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: The endpoints associated with this resource. ,
Required: False ,
}
[
{
endpointUrl:
{
Description: The URL of the endpoint. ,
Required: False ,
}
string ,
type:
{
Description: The type of the endpoint. ,
Enum:
{
ClientApi: The client API endpoint. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
encryption:
{
Description: The account encryption properties. ,
Required: False ,
}
{
type:
{
Description: The type of key used to encrypt the Account Key. ,
Enum:
{
SystemKey: The Account Key is encrypted with a System Key. ,
CustomerKey: The Account Key is encrypted with a Customer Key. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the key used to encrypt the account. ,
Required: False ,
}
{
keyIdentifier:
{
Description: 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). ,
Required: True ,
}
string ,
currentKeyIdentifier:
{
Description: The current key used to encrypt Video Analyzer account, including the key version. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The Key Vault identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the Key Vault mapping. ,
Required: False ,
}
string ,
}
,
iotHubs:
{
Description: The IoT Hubs for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The IoT Hub resource identifier. ,
Required: True ,
}
string ,
identity:
{
Description: The IoT Hub identity. ,
Required: True ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the Iot Hub mapping. ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
networkAccessControl:
{
Description: Network access control for Video Analyzer. ,
Required: False ,
}
{
integration:
{
Description: Public network access for integration group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
ingestion:
{
Description: Public network access for ingestion group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
consumption:
{
Description: Public network access for consumption group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the Video Analyzer account. ,
Enum:
{
Failed: Provisioning state failed. ,
InProgress: Provisioning state in progress. ,
Succeeded: Provisioning state succeeded. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Private Endpoint Connections created under Video Analyzer account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
identity:
{
Description: The identities associated to the Video Analyzer resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Required: True ,
}
string ,
userAssignedIdentities:
{
Description: The User Assigned Managed Identities. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Locations_CheckNameAvailability (removed)
Description :  Checks whether the Video Analyzer resource name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Media/locations/{locationName}/checkNameAvailability
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
locationName:
{
Description: Location Name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates if the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the given name is not available. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Detailed reason why the given name is available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VideoAnalyzers_ListBySubscription (removed)
Description :  List all Video Analyzer accounts in the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Media/videoAnalyzers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of VideoAnalyzer items. ,
Required: False ,
}
[
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
storageAccounts:
{
Description: The storage accounts for this resource. ,
Required: True ,
}
[
{
id:
{
Description: 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). ,
Required: True ,
}
string ,
identity:
{
Description: A managed identity that Video Analyzer will use to access the storage account. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the storage account mapping. ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: The endpoints associated with this resource. ,
Required: False ,
}
[
{
endpointUrl:
{
Description: The URL of the endpoint. ,
Required: False ,
}
string ,
type:
{
Description: The type of the endpoint. ,
Enum:
{
ClientApi: The client API endpoint. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
encryption:
{
Description: The account encryption properties. ,
Required: False ,
}
{
type:
{
Description: The type of key used to encrypt the Account Key. ,
Enum:
{
SystemKey: The Account Key is encrypted with a System Key. ,
CustomerKey: The Account Key is encrypted with a Customer Key. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the key used to encrypt the account. ,
Required: False ,
}
{
keyIdentifier:
{
Description: 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). ,
Required: True ,
}
string ,
currentKeyIdentifier:
{
Description: The current key used to encrypt Video Analyzer account, including the key version. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The Key Vault identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the Key Vault mapping. ,
Required: False ,
}
string ,
}
,
iotHubs:
{
Description: The IoT Hubs for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The IoT Hub resource identifier. ,
Required: True ,
}
string ,
identity:
{
Description: The IoT Hub identity. ,
Required: True ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's resource identifier to use when accessing a resource. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The current status of the Iot Hub mapping. ,
Required: False ,
}
string ,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
networkAccessControl:
{
Description: Network access control for Video Analyzer. ,
Required: False ,
}
{
integration:
{
Description: Public network access for integration group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
ingestion:
{
Description: Public network access for ingestion group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
consumption:
{
Description: Public network access for consumption group. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for specified resources under the Video Analyzer account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
provisioningState:
{
Description: Provisioning state of the Video Analyzer account. ,
Enum:
{
Failed: Provisioning state failed. ,
InProgress: Provisioning state in progress. ,
Succeeded: Provisioning state succeeded. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: Private Endpoint Connections created under Video Analyzer account. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
identity:
{
Description: The identities associated to the Video Analyzer resource. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Required: True ,
}
string ,
userAssignedIdentities:
{
Description: The User Assigned Managed Identities. ,
Required: False ,
}
object ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Videos_List (removed)
Description :  Retrieves a list of video resources that have been created, along with their JSON representations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/videos
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$top:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of VideoEntity items. ,
Required: False ,
}
[
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
title:
{
Description: Optional video title provided by the user. Value can be up to 256 characters long. ,
Required: False ,
}
string ,
description:
{
Description: Optional video description provided by the user. Value can be up to 2048 characters long. ,
Required: False ,
}
string ,
type:
{
Description: Video content type. Different content types are suitable for different applications and scenarios. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
flags:
{
Description: Video flags contain information about the available video actions and its dynamic properties based on the current video state. ,
Required: False ,
}
{
canStream:
{
Description: Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed. ,
Required: True ,
}
boolean ,
hasData:
{
Description: 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. ,
Required: True ,
}
boolean ,
isInUse:
{
Description: Value indicating whether or not the video is currently being referenced be an active pipeline. The fact that is being referenced, doesn't necessarily indicate that data is being received. For example, video recording may be gated on events or camera may not be accessible at the time. ,
Required: True ,
}
boolean ,
}
,
contentUrls:
{
Description: Set of URLs to the video content. ,
Required: False ,
}
{
downloadUrl:
{
Description: Video file download URL. This URL can be used in conjunction with the video content authorization token to download the video MP4 file. The resulting MP4 file can be played on any standard media player. It is available when the video type is 'file' and video file is available for consumption. ,
Required: False ,
}
string ,
archiveBaseUrl:
{
Description: Video archive streaming base URL. The archived content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token on any compatible DASH or HLS players by appending the following to the base URL: - HLSv4: /manifest(format=m3u8-aapl).m3u8 - HLS CMAF: /manifest(format=m3u8-cmaf) - DASH CMAF: /manifest(format=mpd-time-cmaf) Moreover, an ongoing video recording can be played in "live mode" with latencies which are approximately double of the chosen video segment length. It is available when the video type is 'archive' and video archiving is enabled. ,
Required: False ,
}
string ,
rtspTunnelUrl:
{
Description: Video low-latency streaming URL. The live content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token to expose a WebSocket tunneled RTSP stream. It is available when the video type is 'archive' and a live, low-latency feed is available from the source. ,
Required: False ,
}
string ,
previewImageUrls:
{
Description: 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. ,
Required: False ,
}
{
small:
{
Description: Low resolution preview image URL. ,
Required: False ,
}
string ,
medium:
{
Description: Medium resolution preview image URL. ,
Required: False ,
}
string ,
large:
{
Description: High resolution preview image URL. ,
Required: False ,
}
string ,
}
,
}
,
mediaInfo:
{
Description: Contains information about the video and audio content. ,
Required: False ,
}
{
segmentLength:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
archival:
{
Description: Video archival properties. ,
Required: False ,
}
{
retentionPeriod:
{
Description: Video retention period indicates the maximum age of the video archive segments which are intended to be kept in storage. It must be provided in the ISO8601 duration format in the granularity of days, up to a maximum of 10 years. For example, if this is set to P30D (30 days), content older than 30 days will be periodically deleted. This value can be updated at any time and the new desired retention period will be effective within 24 hours. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
@nextLink:
{
Description: A link to the next page of the collection (when the collection contains too many results to return in one response). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Videos_Get (removed)
Description :  Retrieves an existing video resource with the given name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/videos/{videoName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
videoName:
{
Description: The Video name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
title:
{
Description: Optional video title provided by the user. Value can be up to 256 characters long. ,
Required: False ,
}
string ,
description:
{
Description: Optional video description provided by the user. Value can be up to 2048 characters long. ,
Required: False ,
}
string ,
type:
{
Description: Video content type. Different content types are suitable for different applications and scenarios. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
flags:
{
Description: Video flags contain information about the available video actions and its dynamic properties based on the current video state. ,
Required: False ,
}
{
canStream:
{
Description: Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed. ,
Required: True ,
}
boolean ,
hasData:
{
Description: 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. ,
Required: True ,
}
boolean ,
isInUse:
{
Description: Value indicating whether or not the video is currently being referenced be an active pipeline. The fact that is being referenced, doesn't necessarily indicate that data is being received. For example, video recording may be gated on events or camera may not be accessible at the time. ,
Required: True ,
}
boolean ,
}
,
contentUrls:
{
Description: Set of URLs to the video content. ,
Required: False ,
}
{
downloadUrl:
{
Description: Video file download URL. This URL can be used in conjunction with the video content authorization token to download the video MP4 file. The resulting MP4 file can be played on any standard media player. It is available when the video type is 'file' and video file is available for consumption. ,
Required: False ,
}
string ,
archiveBaseUrl:
{
Description: Video archive streaming base URL. The archived content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token on any compatible DASH or HLS players by appending the following to the base URL: - HLSv4: /manifest(format=m3u8-aapl).m3u8 - HLS CMAF: /manifest(format=m3u8-cmaf) - DASH CMAF: /manifest(format=mpd-time-cmaf) Moreover, an ongoing video recording can be played in "live mode" with latencies which are approximately double of the chosen video segment length. It is available when the video type is 'archive' and video archiving is enabled. ,
Required: False ,
}
string ,
rtspTunnelUrl:
{
Description: Video low-latency streaming URL. The live content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token to expose a WebSocket tunneled RTSP stream. It is available when the video type is 'archive' and a live, low-latency feed is available from the source. ,
Required: False ,
}
string ,
previewImageUrls:
{
Description: 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. ,
Required: False ,
}
{
small:
{
Description: Low resolution preview image URL. ,
Required: False ,
}
string ,
medium:
{
Description: Medium resolution preview image URL. ,
Required: False ,
}
string ,
large:
{
Description: High resolution preview image URL. ,
Required: False ,
}
string ,
}
,
}
,
mediaInfo:
{
Description: Contains information about the video and audio content. ,
Required: False ,
}
{
segmentLength:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
archival:
{
Description: Video archival properties. ,
Required: False ,
}
{
retentionPeriod:
{
Description: Video retention period indicates the maximum age of the video archive segments which are intended to be kept in storage. It must be provided in the ISO8601 duration format in the granularity of days, up to a maximum of 10 years. For example, if this is set to P30D (30 days), content older than 30 days will be periodically deleted. This value can be updated at any time and the new desired retention period will be effective within 24 hours. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Videos_CreateOrUpdate (removed)
Description :  Creates a new video resource or updates an existing video resource with the given name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/videos/{videoName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
videoName:
{
Description: The Video name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
title:
{
Description: Optional video title provided by the user. Value can be up to 256 characters long. ,
Required: False ,
}
string ,
description:
{
Description: Optional video description provided by the user. Value can be up to 2048 characters long. ,
Required: False ,
}
string ,
type:
{
Description: Video content type. Different content types are suitable for different applications and scenarios. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
flags:
{
Description: Video flags contain information about the available video actions and its dynamic properties based on the current video state. ,
Required: False ,
}
{
canStream:
{
Description: Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed. ,
Required: True ,
}
boolean ,
hasData:
{
Description: 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. ,
Required: True ,
}
boolean ,
isInUse:
{
Description: Value indicating whether or not the video is currently being referenced be an active pipeline. The fact that is being referenced, doesn't necessarily indicate that data is being received. For example, video recording may be gated on events or camera may not be accessible at the time. ,
Required: True ,
}
boolean ,
}
,
contentUrls:
{
Description: Set of URLs to the video content. ,
Required: False ,
}
{
downloadUrl:
{
Description: Video file download URL. This URL can be used in conjunction with the video content authorization token to download the video MP4 file. The resulting MP4 file can be played on any standard media player. It is available when the video type is 'file' and video file is available for consumption. ,
Required: False ,
}
string ,
archiveBaseUrl:
{
Description: Video archive streaming base URL. The archived content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token on any compatible DASH or HLS players by appending the following to the base URL: - HLSv4: /manifest(format=m3u8-aapl).m3u8 - HLS CMAF: /manifest(format=m3u8-cmaf) - DASH CMAF: /manifest(format=mpd-time-cmaf) Moreover, an ongoing video recording can be played in "live mode" with latencies which are approximately double of the chosen video segment length. It is available when the video type is 'archive' and video archiving is enabled. ,
Required: False ,
}
string ,
rtspTunnelUrl:
{
Description: Video low-latency streaming URL. The live content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token to expose a WebSocket tunneled RTSP stream. It is available when the video type is 'archive' and a live, low-latency feed is available from the source. ,
Required: False ,
}
string ,
previewImageUrls:
{
Description: 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. ,
Required: False ,
}
{
small:
{
Description: Low resolution preview image URL. ,
Required: False ,
}
string ,
medium:
{
Description: Medium resolution preview image URL. ,
Required: False ,
}
string ,
large:
{
Description: High resolution preview image URL. ,
Required: False ,
}
string ,
}
,
}
,
mediaInfo:
{
Description: Contains information about the video and audio content. ,
Required: False ,
}
{
segmentLength:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
archival:
{
Description: Video archival properties. ,
Required: False ,
}
{
retentionPeriod:
{
Description: Video retention period indicates the maximum age of the video archive segments which are intended to be kept in storage. It must be provided in the ISO8601 duration format in the granularity of days, up to a maximum of 10 years. For example, if this is set to P30D (30 days), content older than 30 days will be periodically deleted. This value can be updated at any time and the new desired retention period will be effective within 24 hours. ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
title:
{
Description: Optional video title provided by the user. Value can be up to 256 characters long. ,
Required: False ,
}
string ,
description:
{
Description: Optional video description provided by the user. Value can be up to 2048 characters long. ,
Required: False ,
}
string ,
type:
{
Description: Video content type. Different content types are suitable for different applications and scenarios. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
flags:
{
Description: Video flags contain information about the available video actions and its dynamic properties based on the current video state. ,
Required: False ,
}
{
canStream:
{
Description: Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed. ,
Required: True ,
}
boolean ,
hasData:
{
Description: 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. ,
Required: True ,
}
boolean ,
isInUse:
{
Description: Value indicating whether or not the video is currently being referenced be an active pipeline. The fact that is being referenced, doesn't necessarily indicate that data is being received. For example, video recording may be gated on events or camera may not be accessible at the time. ,
Required: True ,
}
boolean ,
}
,
contentUrls:
{
Description: Set of URLs to the video content. ,
Required: False ,
}
{
downloadUrl:
{
Description: Video file download URL. This URL can be used in conjunction with the video content authorization token to download the video MP4 file. The resulting MP4 file can be played on any standard media player. It is available when the video type is 'file' and video file is available for consumption. ,
Required: False ,
}
string ,
archiveBaseUrl:
{
Description: Video archive streaming base URL. The archived content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token on any compatible DASH or HLS players by appending the following to the base URL: - HLSv4: /manifest(format=m3u8-aapl).m3u8 - HLS CMAF: /manifest(format=m3u8-cmaf) - DASH CMAF: /manifest(format=mpd-time-cmaf) Moreover, an ongoing video recording can be played in "live mode" with latencies which are approximately double of the chosen video segment length. It is available when the video type is 'archive' and video archiving is enabled. ,
Required: False ,
}
string ,
rtspTunnelUrl:
{
Description: Video low-latency streaming URL. The live content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token to expose a WebSocket tunneled RTSP stream. It is available when the video type is 'archive' and a live, low-latency feed is available from the source. ,
Required: False ,
}
string ,
previewImageUrls:
{
Description: 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. ,
Required: False ,
}
{
small:
{
Description: Low resolution preview image URL. ,
Required: False ,
}
string ,
medium:
{
Description: Medium resolution preview image URL. ,
Required: False ,
}
string ,
large:
{
Description: High resolution preview image URL. ,
Required: False ,
}
string ,
}
,
}
,
mediaInfo:
{
Description: Contains information about the video and audio content. ,
Required: False ,
}
{
segmentLength:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
archival:
{
Description: Video archival properties. ,
Required: False ,
}
{
retentionPeriod:
{
Description: Video retention period indicates the maximum age of the video archive segments which are intended to be kept in storage. It must be provided in the ISO8601 duration format in the granularity of days, up to a maximum of 10 years. For example, if this is set to P30D (30 days), content older than 30 days will be periodically deleted. This value can be updated at any time and the new desired retention period will be effective within 24 hours. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
title:
{
Description: Optional video title provided by the user. Value can be up to 256 characters long. ,
Required: False ,
}
string ,
description:
{
Description: Optional video description provided by the user. Value can be up to 2048 characters long. ,
Required: False ,
}
string ,
type:
{
Description: Video content type. Different content types are suitable for different applications and scenarios. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
flags:
{
Description: Video flags contain information about the available video actions and its dynamic properties based on the current video state. ,
Required: False ,
}
{
canStream:
{
Description: Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed. ,
Required: True ,
}
boolean ,
hasData:
{
Description: 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. ,
Required: True ,
}
boolean ,
isInUse:
{
Description: Value indicating whether or not the video is currently being referenced be an active pipeline. The fact that is being referenced, doesn't necessarily indicate that data is being received. For example, video recording may be gated on events or camera may not be accessible at the time. ,
Required: True ,
}
boolean ,
}
,
contentUrls:
{
Description: Set of URLs to the video content. ,
Required: False ,
}
{
downloadUrl:
{
Description: Video file download URL. This URL can be used in conjunction with the video content authorization token to download the video MP4 file. The resulting MP4 file can be played on any standard media player. It is available when the video type is 'file' and video file is available for consumption. ,
Required: False ,
}
string ,
archiveBaseUrl:
{
Description: Video archive streaming base URL. The archived content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token on any compatible DASH or HLS players by appending the following to the base URL: - HLSv4: /manifest(format=m3u8-aapl).m3u8 - HLS CMAF: /manifest(format=m3u8-cmaf) - DASH CMAF: /manifest(format=mpd-time-cmaf) Moreover, an ongoing video recording can be played in "live mode" with latencies which are approximately double of the chosen video segment length. It is available when the video type is 'archive' and video archiving is enabled. ,
Required: False ,
}
string ,
rtspTunnelUrl:
{
Description: Video low-latency streaming URL. The live content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token to expose a WebSocket tunneled RTSP stream. It is available when the video type is 'archive' and a live, low-latency feed is available from the source. ,
Required: False ,
}
string ,
previewImageUrls:
{
Description: 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. ,
Required: False ,
}
{
small:
{
Description: Low resolution preview image URL. ,
Required: False ,
}
string ,
medium:
{
Description: Medium resolution preview image URL. ,
Required: False ,
}
string ,
large:
{
Description: High resolution preview image URL. ,
Required: False ,
}
string ,
}
,
}
,
mediaInfo:
{
Description: Contains information about the video and audio content. ,
Required: False ,
}
{
segmentLength:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
archival:
{
Description: Video archival properties. ,
Required: False ,
}
{
retentionPeriod:
{
Description: Video retention period indicates the maximum age of the video archive segments which are intended to be kept in storage. It must be provided in the ISO8601 duration format in the granularity of days, up to a maximum of 10 years. For example, if this is set to P30D (30 days), content older than 30 days will be periodically deleted. This value can be updated at any time and the new desired retention period will be effective within 24 hours. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Videos_Delete (removed)
Description :  Deletes an existing video resource and its underlying data. This operation is irreversible.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/videos/{videoName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
videoName:
{
Description: The Video name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Videos_Update (removed)
Description :  Updates individual properties of an existing video resource with the given name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/videos/{videoName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
videoName:
{
Description: The Video name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
title:
{
Description: Optional video title provided by the user. Value can be up to 256 characters long. ,
Required: False ,
}
string ,
description:
{
Description: Optional video description provided by the user. Value can be up to 2048 characters long. ,
Required: False ,
}
string ,
type:
{
Description: Video content type. Different content types are suitable for different applications and scenarios. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
flags:
{
Description: Video flags contain information about the available video actions and its dynamic properties based on the current video state. ,
Required: False ,
}
{
canStream:
{
Description: Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed. ,
Required: True ,
}
boolean ,
hasData:
{
Description: 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. ,
Required: True ,
}
boolean ,
isInUse:
{
Description: Value indicating whether or not the video is currently being referenced be an active pipeline. The fact that is being referenced, doesn't necessarily indicate that data is being received. For example, video recording may be gated on events or camera may not be accessible at the time. ,
Required: True ,
}
boolean ,
}
,
contentUrls:
{
Description: Set of URLs to the video content. ,
Required: False ,
}
{
downloadUrl:
{
Description: Video file download URL. This URL can be used in conjunction with the video content authorization token to download the video MP4 file. The resulting MP4 file can be played on any standard media player. It is available when the video type is 'file' and video file is available for consumption. ,
Required: False ,
}
string ,
archiveBaseUrl:
{
Description: Video archive streaming base URL. The archived content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token on any compatible DASH or HLS players by appending the following to the base URL: - HLSv4: /manifest(format=m3u8-aapl).m3u8 - HLS CMAF: /manifest(format=m3u8-cmaf) - DASH CMAF: /manifest(format=mpd-time-cmaf) Moreover, an ongoing video recording can be played in "live mode" with latencies which are approximately double of the chosen video segment length. It is available when the video type is 'archive' and video archiving is enabled. ,
Required: False ,
}
string ,
rtspTunnelUrl:
{
Description: Video low-latency streaming URL. The live content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token to expose a WebSocket tunneled RTSP stream. It is available when the video type is 'archive' and a live, low-latency feed is available from the source. ,
Required: False ,
}
string ,
previewImageUrls:
{
Description: 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. ,
Required: False ,
}
{
small:
{
Description: Low resolution preview image URL. ,
Required: False ,
}
string ,
medium:
{
Description: Medium resolution preview image URL. ,
Required: False ,
}
string ,
large:
{
Description: High resolution preview image URL. ,
Required: False ,
}
string ,
}
,
}
,
mediaInfo:
{
Description: Contains information about the video and audio content. ,
Required: False ,
}
{
segmentLength:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
archival:
{
Description: Video archival properties. ,
Required: False ,
}
{
retentionPeriod:
{
Description: Video retention period indicates the maximum age of the video archive segments which are intended to be kept in storage. It must be provided in the ISO8601 duration format in the granularity of days, up to a maximum of 10 years. For example, if this is set to P30D (30 days), content older than 30 days will be periodically deleted. This value can be updated at any time and the new desired retention period will be effective within 24 hours. ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
title:
{
Description: Optional video title provided by the user. Value can be up to 256 characters long. ,
Required: False ,
}
string ,
description:
{
Description: Optional video description provided by the user. Value can be up to 2048 characters long. ,
Required: False ,
}
string ,
type:
{
Description: Video content type. Different content types are suitable for different applications and scenarios. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
flags:
{
Description: Video flags contain information about the available video actions and its dynamic properties based on the current video state. ,
Required: False ,
}
{
canStream:
{
Description: Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed. ,
Required: True ,
}
boolean ,
hasData:
{
Description: 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. ,
Required: True ,
}
boolean ,
isInUse:
{
Description: Value indicating whether or not the video is currently being referenced be an active pipeline. The fact that is being referenced, doesn't necessarily indicate that data is being received. For example, video recording may be gated on events or camera may not be accessible at the time. ,
Required: True ,
}
boolean ,
}
,
contentUrls:
{
Description: Set of URLs to the video content. ,
Required: False ,
}
{
downloadUrl:
{
Description: Video file download URL. This URL can be used in conjunction with the video content authorization token to download the video MP4 file. The resulting MP4 file can be played on any standard media player. It is available when the video type is 'file' and video file is available for consumption. ,
Required: False ,
}
string ,
archiveBaseUrl:
{
Description: Video archive streaming base URL. The archived content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token on any compatible DASH or HLS players by appending the following to the base URL: - HLSv4: /manifest(format=m3u8-aapl).m3u8 - HLS CMAF: /manifest(format=m3u8-cmaf) - DASH CMAF: /manifest(format=mpd-time-cmaf) Moreover, an ongoing video recording can be played in "live mode" with latencies which are approximately double of the chosen video segment length. It is available when the video type is 'archive' and video archiving is enabled. ,
Required: False ,
}
string ,
rtspTunnelUrl:
{
Description: Video low-latency streaming URL. The live content can be automatically played by the Azure Video Analyzer player widget. Alternatively, this URL can be used in conjunction with the video content authorization token to expose a WebSocket tunneled RTSP stream. It is available when the video type is 'archive' and a live, low-latency feed is available from the source. ,
Required: False ,
}
string ,
previewImageUrls:
{
Description: 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. ,
Required: False ,
}
{
small:
{
Description: Low resolution preview image URL. ,
Required: False ,
}
string ,
medium:
{
Description: Medium resolution preview image URL. ,
Required: False ,
}
string ,
large:
{
Description: High resolution preview image URL. ,
Required: False ,
}
string ,
}
,
}
,
mediaInfo:
{
Description: Contains information about the video and audio content. ,
Required: False ,
}
{
segmentLength:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
archival:
{
Description: Video archival properties. ,
Required: False ,
}
{
retentionPeriod:
{
Description: Video retention period indicates the maximum age of the video archive segments which are intended to be kept in storage. It must be provided in the ISO8601 duration format in the granularity of days, up to a maximum of 10 years. For example, if this is set to P30D (30 days), content older than 30 days will be periodically deleted. This value can be updated at any time and the new desired retention period will be effective within 24 hours. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Videos_ListContentToken (removed)
Description :  Generates a streaming token which can be used for accessing content from video content URLs, for a video resource with the given name.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/videos/{videoName}/listContentToken
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
videoName:
{
Description: The Video name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
expirationDate:
{
Description: The content token expiration date in ISO8601 format (eg. 2021-01-01T00:00:00Z). ,
Format: date-time ,
Required: False ,
}
string ,
token:
{
Description: The content token value to be added to the video content URL as the value for the "token" query string parameter. The token is specific to a single video. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AccessPolicies_List (removed)
Description :  Retrieves all existing access policy resources, along with their JSON representations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/accessPolicies
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$top:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: A collection of AccessPolicyEntity items. ,
Required: False ,
}
[
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
role:
{
Description: Defines the access level granted by this policy. ,
Enum:
{
Reader: Reader role allows for read-only operations to be performed through the client APIs. ,
}
,
Required: False ,
}
enum ,
authentication:
{
Description: Authentication method to be used when validating client API access. ,
Required: False ,
}
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
@nextLink:
{
Description: A link to the next page of the collection (when the collection contains too many results to return in one response). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AccessPolicies_Get (removed)
Description :  Retrieves an existing access policy resource with the given name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/accessPolicies/{accessPolicyName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
accessPolicyName:
{
Description: The Access Policy name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
role:
{
Description: Defines the access level granted by this policy. ,
Enum:
{
Reader: Reader role allows for read-only operations to be performed through the client APIs. ,
}
,
Required: False ,
}
enum ,
authentication:
{
Description: Authentication method to be used when validating client API access. ,
Required: False ,
}
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AccessPolicies_CreateOrUpdate (removed)
Description :  Creates a new access policy resource or updates an existing one with the given name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/accessPolicies/{accessPolicyName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
accessPolicyName:
{
Description: The Access Policy name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
role:
{
Description: Defines the access level granted by this policy. ,
Enum:
{
Reader: Reader role allows for read-only operations to be performed through the client APIs. ,
}
,
Required: False ,
}
enum ,
authentication:
{
Description: Authentication method to be used when validating client API access. ,
Required: False ,
}
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
role:
{
Description: Defines the access level granted by this policy. ,
Enum:
{
Reader: Reader role allows for read-only operations to be performed through the client APIs. ,
}
,
Required: False ,
}
enum ,
authentication:
{
Description: Authentication method to be used when validating client API access. ,
Required: False ,
}
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
role:
{
Description: Defines the access level granted by this policy. ,
Enum:
{
Reader: Reader role allows for read-only operations to be performed through the client APIs. ,
}
,
Required: False ,
}
enum ,
authentication:
{
Description: Authentication method to be used when validating client API access. ,
Required: False ,
}
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AccessPolicies_Delete (removed)
Description :  Deletes an existing access policy resource with the given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/accessPolicies/{accessPolicyName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
accessPolicyName:
{
Description: The Access Policy name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AccessPolicies_Update (removed)
Description :  Updates individual properties of an existing access policy resource with the given name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/accessPolicies/{accessPolicyName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The Azure Video Analyzer account name. ,
Required: True ,
}
string ,
accessPolicyName:
{
Description: The Access Policy name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
role:
{
Description: Defines the access level granted by this policy. ,
Enum:
{
Reader: Reader role allows for read-only operations to be performed through the client APIs. ,
}
,
Required: False ,
}
enum ,
authentication:
{
Description: Authentication method to be used when validating client API access. ,
Required: False ,
}
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
role:
{
Description: Defines the access level granted by this policy. ,
Enum:
{
Reader: Reader role allows for read-only operations to be performed through the client APIs. ,
}
,
Required: False ,
}
enum ,
authentication:
{
Description: Authentication method to be used when validating client API access. ,
Required: False ,
}
{
@type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}