Accounts - Get

Reference

Service:: Azure Video Indexer

API Version:: 2024-01-01

Gets the properties of an Azure Video Indexer account.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}?api-version=2024-01-01

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	The name of the Azure Video Indexer account. Regex pattern: `^[A-Za-z0-9-]+$`
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	Account	The Azure Video Indexer account properties were retrieved successfully.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get account

Sample request

HTTP

GET https://management.azure.com/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer?api-version=2024-01-01

Sample response

Status code:: 200

{
  "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoanalyzer",
  "name": "vi1",
  "type": "Microsoft.VideoIndexer/accounts",
  "location": "NorthEurope",
  "tags": {},
  "properties": {
    "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e",
    "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574",
    "accountName": "contosto-videoanalyzer",
    "storageServices": {
      "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms",
      "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi"
    },
    "provisioningState": "Succeeded"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {
        "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13",
        "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7"
      }
    }
  }
}

Definitions

Name	Description
Account	An Azure Video Indexer account.
createdByType	The type of identity that created the resource.
ErrorDefinition	Error definition.
ErrorResponse	Error response.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
provisioningState	Gets the status of the account at the time the operation was called.
StorageServicesForPutRequest	The storage services details
systemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity	User assigned identity properties

Account

An Azure Video Indexer account.

Name	Type	Default value	Description
id	string		Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity		Managed service identity (system assigned and/or user assigned identities)
location	string		The geo-location where the resource lives
name	string		The name of the resource
properties.accountId	string	00000000-0000-0000-0000-000000000000	The account's data-plane ID. This can be set only when connecting an existing classic account
properties.accountName	string		The account's name
properties.provisioningState	provisioningState		Gets the status of the account at the time the operation was called.
properties.storageServices	StorageServicesForPutRequest		The storage services details
properties.tenantId	string		The account's tenant id
properties.totalSecondsIndexed	integer		An integer representing the total seconds that have been indexed on the account
systemData	systemData		The system meta data relating to this resource.
tags	object		Resource tags.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDefinition

Error definition.

Name	Type	Description
code	string	Service specific error code which serves as the substatus for the HTTP error code.
details	ErrorDefinition[]	Internal error details.
message	string	Description of the error.

ErrorResponse

Error response.

Name	Type	Description
error	ErrorDefinition	The error details.

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

provisioningState

Gets the status of the account at the time the operation was called.

Name	Type	Description
Accepted	string
Canceled	string
Deleting	string
Failed	string
Provisioning	string
Succeeded	string

StorageServicesForPutRequest

The storage services details

Name	Type	Description
resourceId	string	The storage services resource id
userAssignedIdentity	string	The user assigned identity to be used to grant permissions

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserAssignedIdentity

User assigned identity properties

Name	Type	Description
clientId	string	The client ID of the assigned identity.
principalId	string	The principal ID of the assigned identity.

Share via