Microsoft Azure Video Analyzer is a cloud-based service that uses artificial intelligence and machine learning algorithms to analyze and extract insights from video content. It can detect objects, faces, emotions, activities, and other visual elements within a video, providing valuable data and analytics. With Azure Video Analyzer, users can easily search, filter, and categorize large volumes of video content, making it easier to find relevant information quickly.
schemes:
- https
swagger: '2.0'
info:
title: Microsoft Azure Azure Video Analyzer
description: Azure Video Analyzer resource provider API definition.
version: 2021-11-01-preview
host: management.azure.com
consumes:
- application/json
produces:
- application/json
securityDefinitions:
azure_auth:
type: oauth2
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
flow: implicit
description: Azure Active Directory OAuth2 Flow
scopes:
user_impersonation: Impersonate your user account
definitions:
OperationDisplay:
properties:
provider:
type: string
description: The service provider.
resource:
type: string
description: Resource on which the operation is performed.
operation:
type: string
description: The operation type.
description:
type: string
description: The operation description.
type: object
description: Operation details.
MetricDimension:
properties:
name:
type: string
description: The metric dimension name.
readOnly: true
displayName:
type: string
description: The display name for the dimension.
readOnly: true
toBeExportedForShoebox:
type: boolean
description: Whether to export metric to shoebox.
readOnly: true
x-nullable: false
type: object
description: A metric dimension.
MetricSpecification:
properties:
name:
type: string
description: The metric name.
readOnly: true
displayName:
type: string
description: The metric display name.
readOnly: true
displayDescription:
type: string
description: The metric display description.
readOnly: true
unit:
type: string
enum:
- Bytes
- Count
- Milliseconds
x-ms-enum:
name: MetricUnit
values:
- value: Bytes
description: The number of bytes.
- value: Count
description: The count.
- value: Milliseconds
description: The number of milliseconds.
modelAsString: true
description: The metric unit
readOnly: true
x-nullable: false
aggregationType:
type: string
enum:
- Average
- Count
- Total
x-ms-enum:
name: MetricAggregationType
values:
- value: Average
description: The average.
- value: Count
description: The count of a number of items, usually requests.
- value: Total
description: The sum.
modelAsString: true
description: The metric aggregation type
readOnly: true
x-nullable: false
lockAggregationType:
type: string
enum:
- Average
- Count
- Total
x-ms-enum:
name: MetricAggregationType
values:
- value: Average
description: The average.
- value: Count
description: The count of a number of items, usually requests.
- value: Total
description: The sum.
modelAsString: true
description: The metric lock aggregation type
readOnly: true
x-nullable: true
supportedAggregationTypes:
type: array
items:
type: string
description: Supported aggregation types.
dimensions:
type: array
items:
$ref: '#/definitions/MetricDimension'
x-ms-identifiers:
- name
description: The metric dimensions.
readOnly: true
enableRegionalMdmAccount:
type: boolean
description: Indicates whether regional MDM account is enabled.
readOnly: true
x-nullable: false
sourceMdmAccount:
type: string
description: The source MDM account.
readOnly: true
sourceMdmNamespace:
type: string
description: The source MDM namespace.
readOnly: true
supportedTimeGrainTypes:
type: array
items:
type: string
description: The supported time grain types.
readOnly: true
type: object
description: A metric emitted by service.
Properties:
properties:
serviceSpecification:
$ref: '#/definitions/ServiceSpecification'
description: The service specifications.
readOnly: true
type: object
description: Metric properties.
ServiceSpecification:
properties:
logSpecifications:
type: array
items:
$ref: '#/definitions/LogSpecification'
x-ms-identifiers:
- blobDuration
- name
description: List of log specifications.
readOnly: true
metricSpecifications:
type: array
items:
$ref: '#/definitions/MetricSpecification'
x-ms-identifiers:
- name
- unit
description: List of metric specifications.
readOnly: true
type: object
description: The service metric specifications.
LogSpecification:
properties:
name:
type: string
description: The diagnostic log category name.
readOnly: true
displayName:
type: string
description: The diagnostic log category display name.
readOnly: true
blobDuration:
type: string
description: The time range for requests in each blob.
readOnly: true
type: object
description: A diagnostic log emitted by service.
Operation:
properties:
name:
type: string
description: The operation name.
display:
$ref: '#/definitions/OperationDisplay'
description: The operation display name.
origin:
type: string
description: Origin of the operation.
properties:
$ref: '#/definitions/Properties'
description: Operation properties format.
isDataAction:
type: boolean
description: Whether the operation applies to data-plane.
x-nullable: true
actionType:
type: string
enum:
- Internal
x-ms-enum:
name: ActionType
values:
- value: Internal
description: An internal action.
modelAsString: true
description: Indicates the action type.
x-nullable: true
type: object
required:
- name
description: An operation.
StorageAccount:
properties:
id:
type: string
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).
identity:
$ref: '#/definitions/ResourceIdentity'
description: >-
A managed identity that Video Analyzer will use to access the storage
account.
status:
type: string
description: The current status of the storage account mapping.
readOnly: true
type: object
required:
- id
description: The details about the associated storage account.
VideoAnalyzerProperties:
properties:
storageAccounts:
type: array
items:
$ref: '#/definitions/StorageAccount'
description: The storage accounts for this resource.
endpoints:
type: array
items:
$ref: '#/definitions/Endpoint'
x-ms-identifiers:
- endpointUrl
description: The endpoints associated with this resource.
readOnly: true
encryption:
$ref: '#/definitions/AccountEncryption'
description: The account encryption properties.
iotHubs:
type: array
items:
$ref: '#/definitions/IotHub'
description: The IoT Hubs for this resource.
publicNetworkAccess:
type: string
enum:
- Enabled
- Disabled
x-ms-enum:
name: PublicNetworkAccess
values:
- value: Enabled
description: Public network access is enabled.
- value: Disabled
description: Public network access is disabled.
modelAsString: true
description: >-
Whether or not public network access is allowed for resources under
the Video Analyzer account.
x-nullable: true
networkAccessControl:
$ref: '#/definitions/NetworkAccessControl'
description: Network access control for Video Analyzer.
x-nullable: true
provisioningState:
type: string
enum:
- Failed
- InProgress
- Succeeded
x-ms-enum:
name: ProvisioningState
values:
- value: Failed
description: Provisioning state failed.
- value: InProgress
description: Provisioning state in progress.
- value: Succeeded
description: Provisioning state succeeded.
modelAsString: true
description: Provisioning state of the Video Analyzer account.
readOnly: true
x-nullable: false
privateEndpointConnections:
items:
$ref: >-
../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnection
type: array
description: Private Endpoint Connections created under Video Analyzer account.
readOnly: true
type: object
required:
- storageAccounts
description: The properties of the Video Analyzer account.
VideoAnalyzerPropertiesUpdate:
properties:
storageAccounts:
type: array
items:
$ref: '#/definitions/StorageAccount'
description: The storage accounts for this resource.
endpoints:
type: array
items:
$ref: '#/definitions/Endpoint'
x-ms-identifiers:
- endpointUrl
description: The endpoints associated with this resource.
readOnly: true
encryption:
$ref: '#/definitions/AccountEncryption'
description: The account encryption properties.
iotHubs:
type: array
items:
$ref: '#/definitions/IotHub'
description: The IoT Hubs for this resource.
publicNetworkAccess:
type: string
enum:
- Enabled
- Disabled
x-ms-enum:
name: PublicNetworkAccess
values:
- value: Enabled
description: Public network access is enabled.
- value: Disabled
description: Public network access is disabled.
modelAsString: true
description: >-
Whether or not public network access is allowed for resources under
the Video Analyzer account.
x-nullable: true
networkAccessControl:
$ref: '#/definitions/NetworkAccessControl'
description: Network access control for Video Analyzer.
x-nullable: true
provisioningState:
type: string
enum:
- Failed
- InProgress
- Succeeded
x-ms-enum:
name: ProvisioningState
values:
- value: Failed
description: Provisioning state failed.
- value: InProgress
description: Provisioning state in progress.
- value: Succeeded
description: Provisioning state succeeded.
modelAsString: true
description: Provisioning state of the Video Analyzer account.
readOnly: true
x-nullable: false
privateEndpointConnections:
items:
$ref: >-
../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnection
type: array
description: Private Endpoint Connections created under Video Analyzer account.
readOnly: true
type: object
description: The properties of the Video Analyzer account.
VideoAnalyzer:
allOf:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource
properties:
properties:
$ref: '#/definitions/VideoAnalyzerProperties'
description: The resource properties.
x-ms-client-flatten: true
identity:
$ref: '#/definitions/VideoAnalyzerIdentity'
description: The identities associated to the Video Analyzer resource.
type: object
description: The Video Analyzer account.
VideoAnalyzerUpdate:
properties:
tags:
type: object
additionalProperties:
type: string
x-ms-mutability:
- read
- create
- update
description: Resource tags.
properties:
$ref: '#/definitions/VideoAnalyzerPropertiesUpdate'
description: The resource properties.
x-ms-client-flatten: true
identity:
$ref: '#/definitions/VideoAnalyzerIdentity'
description: The identities associated to the Video Analyzer resource.
type: object
description: The update operation for a Video Analyzer account.
Endpoint:
properties:
endpointUrl:
type: string
description: The URL of the endpoint.
type:
type: string
enum:
- ClientApi
x-ms-enum:
name: VideoAnalyzerEndpointType
values:
- value: ClientApi
description: The client API endpoint.
modelAsString: true
description: The type of the endpoint.
type: object
required:
- type
description: The endpoint details.
UserAssignedManagedIdentity:
properties:
clientId:
type: string
format: uuid
description: The client ID.
readOnly: true
x-nullable: true
principalId:
type: string
format: uuid
description: The principal ID.
readOnly: true
x-nullable: true
type: object
description: >-
The details of the user assigned managed identity used by the Video
Analyzer resource.
UserAssignedManagedIdentities:
type: object
description: The User Assigned Managed Identities.
additionalProperties:
$ref: '#/definitions/UserAssignedManagedIdentity'
VideoAnalyzerIdentity:
properties:
type:
type: string
description: The identity type.
userAssignedIdentities:
$ref: '#/definitions/UserAssignedManagedIdentities'
description: The User Assigned Managed Identities.
type: object
required:
- type
description: The managed identity for the Video Analyzer resource.
ResourceIdentity:
properties:
userAssignedIdentity:
type: string
description: >-
The user assigned managed identity's resource identifier to use when
accessing a resource.
type: object
required:
- userAssignedIdentity
description: The user assigned managed identity to use when accessing a resource.
KeyVaultProperties:
properties:
keyIdentifier:
type: string
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).
currentKeyIdentifier:
type: string
description: >-
The current key used to encrypt Video Analyzer account, including the
key version.
readOnly: true
type: object
required:
- keyIdentifier
description: The details for accessing the encryption keys in Key Vault.
AccountEncryption:
properties:
type:
type: string
enum:
- SystemKey
- CustomerKey
x-ms-enum:
name: AccountEncryptionKeyType
values:
- value: SystemKey
description: The Account Key is encrypted with a System Key.
- value: CustomerKey
description: The Account Key is encrypted with a Customer Key.
modelAsString: true
description: The type of key used to encrypt the Account Key.
keyVaultProperties:
$ref: '#/definitions/KeyVaultProperties'
description: The properties of the key used to encrypt the account.
identity:
$ref: '#/definitions/ResourceIdentity'
description: The Key Vault identity.
status:
type: string
description: The current status of the Key Vault mapping.
readOnly: true
type: object
required:
- type
description: Defines how the Video Analyzer account is (optionally) encrypted.
IotHub:
properties:
id:
type: string
description: The IoT Hub resource identifier.
identity:
$ref: '#/definitions/ResourceIdentity'
description: The IoT Hub identity.
status:
type: string
description: The current status of the Iot Hub mapping.
readOnly: true
type: object
required:
- id
- identity
description: The IoT Hub details.
GroupLevelAccessControl:
properties:
publicNetworkAccess:
type: string
enum:
- Enabled
- Disabled
x-ms-enum:
name: PublicNetworkAccess
values:
- value: Enabled
description: Public network access is enabled.
- value: Disabled
description: Public network access is disabled.
modelAsString: true
description: >-
Whether or not public network access is allowed for specified
resources under the Video Analyzer account.
x-nullable: true
type: object
description: Group level network access control.
NetworkAccessControl:
properties:
integration:
$ref: '#/definitions/GroupLevelAccessControl'
description: Public network access for integration group.
x-nullable: true
ingestion:
$ref: '#/definitions/GroupLevelAccessControl'
description: Public network access for ingestion group.
x-nullable: true
consumption:
$ref: '#/definitions/GroupLevelAccessControl'
description: Public network access for consumption group.
x-nullable: true
type: object
description: Network access control for video analyzer account.
VideoAnalyzerPrivateEndpointConnectionOperationStatus:
properties:
name:
type: string
description: Operation identifier.
id:
type: string
description: Operation resource ID.
startTime:
type: string
description: Operation start time.
endTime:
type: string
description: Operation end time.
status:
type: string
description: Operation status.
error:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail
x-nullable: true
type: object
required:
- name
description: Status of private endpoint connection operation.
VideoAnalyzerOperationStatus:
properties:
name:
type: string
description: Operation identifier.
id:
type: string
description: Operation resource ID.
startTime:
type: string
description: Operation start time.
endTime:
type: string
description: Operation end time.
status:
type: string
description: Operation status.
error:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail
x-nullable: true
type: object
required:
- name
description: Status of video analyzer operation.
OperationCollection:
properties:
value:
type: array
items:
$ref: '#/definitions/Operation'
x-ms-identifiers:
- name
description: A collection of Operation items.
type: object
description: A collection of Operation items.
VideoAnalyzerCollection:
properties:
value:
type: array
items:
$ref: '#/definitions/VideoAnalyzer'
description: A collection of VideoAnalyzer items.
type: object
description: A collection of VideoAnalyzer items.
paths:
/providers/Microsoft.Media/operations:
get:
summary: Microsoft Azure List Operations
description: Lists all the Media operations.
operationId: microsoftAzureOperationsList
responses:
'200':
description: OK
schema:
$ref: '#/definitions/OperationCollection'
default:
description: Detailed error information.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
x-ms-examples:
List Operations:
$ref: examples/operations-list-all.json
tags:
- Providers
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers:
get:
summary: Microsoft Azure List Video Analyzer Accounts
description: Lists the Video Analyzer accounts in the specified resource group.
operationId: microsoftAzureVideoanalyzersList
responses:
'200':
description: OK
schema:
$ref: '#/definitions/VideoAnalyzerCollection'
default:
description: Detailed error information.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
x-ms-examples:
List all Video Analyzer accounts:
$ref: examples/video-analyzer-accounts-list-all-accounts.json
tags:
- Subscriptions
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}:
get:
summary: Microsoft Azure Get A Video Analyzer Account
description: Get the details of the specified Video Analyzer account
operationId: microsoftAzureVideoanalyzersGet
responses:
'200':
description: OK
schema:
$ref: '#/definitions/VideoAnalyzer'
default:
description: Detailed error information.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: accountName
in: path
required: true
type: string
description: The Video Analyzer account name.
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
x-ms-examples:
Get a Video Analyzer account by name:
$ref: examples/video-analyzer-accounts-get-by-name.json
tags:
- Subscriptions
put:
summary: Microsoft Azure Create Or Update A Video Analyzer Account
description: Create or update an instance of a Video Analyzer account
operationId: microsoftAzureVideoanalyzersCreateorupdate
responses:
'200':
description: OK
schema:
$ref: '#/definitions/VideoAnalyzer'
'201':
description: Created
headers:
Retry-After:
description: >-
The recommended number of seconds to wait before calling the URI
specified in Azure-AsyncOperation.
type: integer
format: int32
Location:
description: The URI to poll for completion status.
type: string
Azure-AsyncOperation:
description: The URI to poll for completion status.
type: string
schema:
$ref: '#/definitions/VideoAnalyzer'
default:
description: Detailed error information.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: accountName
in: path
required: true
type: string
description: The Video Analyzer account name.
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/VideoAnalyzer'
description: The request parameters
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
x-ms-long-running-operation: true
x-ms-examples:
Create a Video Analyzer account:
$ref: examples/video-analyzer-accounts-create-or-update.json
tags:
- Subscriptions
delete:
summary: 'Microsoft Azure Delete A Video Analyzer Account'
description: Delete the specified Video Analyzer account
operationId: microsoftAzureVideoanalyzersDelete
responses:
'200':
description: OK
'204':
description: NoContent
default:
description: Detailed error information.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: accountName
in: path
required: true
type: string
description: The Video Analyzer account name.
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
x-ms-examples:
Delete a Video Analyzer account:
$ref: examples/video-analyzer-accounts-delete.json
tags:
- Subscriptions
patch:
summary: Microsoft Azure Update A Video Analyzer Account
description: Updates an existing instance of Video Analyzer account
operationId: microsoftAzureVideoanalyzersUpdate
responses:
'202':
description: Accepted
headers:
Retry-After:
description: >-
The recommended number of seconds to wait before calling the URI
specified in Azure-AsyncOperation.
type: integer
format: int32
Location:
description: The URI to poll for completion status.
type: string
Azure-AsyncOperation:
description: The URI to poll for completion status.
type: string
schema:
$ref: '#/definitions/VideoAnalyzer'
default:
description: Detailed error information.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: accountName
in: path
required: true
type: string
description: The Video Analyzer account name.
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/VideoAnalyzerUpdate'
description: The request parameters
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
x-ms-long-running-operation: true
x-ms-examples:
Update a Video Analyzer accounts:
$ref: examples/video-analyzer-accounts-update.json
tags:
- Subscriptions
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/privateLinkResources
: get:
summary: 'Microsoft Azure Get List Of Group Ids'
description: Get list of group IDs for video analyzer account.
operationId: microsoftAzurePrivatelinkresourcesList
responses:
'200':
description: OK
schema:
$ref: >-
../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateLinkResourceListResult
default:
description: Detailed error information.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: accountName
in: path
required: true
type: string
description: The Video Analyzer account name.
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
x-ms-examples:
Get list of all group IDs.:
$ref: examples/video-analyzer-private-link-resources-list.json
tags:
- Subscriptions
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/videoAnalyzers/{accountName}/privateLinkResources/{name}
: get:
summary: 'Microsoft Azure Get Group Id'
description: Get group ID for video analyzer account.
operationId: microsoftAzurePrivatelinkresourcesGet
responses:
'200':
description: OK
schema:
$ref: >-
../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateLinkResource
default:
description: Detailed error information.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: accountName
in: path
required: true
type: string
description: The Video Analyzer account name.
- name: name
in: path
required: true
type: string
description: Name of the private link resource (Group ID).
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
x-ms-examples:
Get details of a group ID.:
$ref: examples/video-analyzer-private-link-resources-get-by-name.json
tags:
- Subscriptions
? /subscriptions/{subscriptionId}/resourceGroup
# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/azure-video-analyzer-openapi-original.yml