Generate - Access Token

  • Referência
Service:
Azure Video Indexer
API Version:
2024-01-01

Gerar um token de acesso do Azure Video Indexer.

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

Parâmetros do URI

Name Em Necessário Tipo Description
accountName
 path True

string

O nome da conta do Video Indexer do Azure.

Regex pattern: ^[A-Za-z0-9-]+$
resourceGroupName
 path True

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId
 path True

string

O ID da subscrição de destino.
api-version
 query True

string

A versão da API a utilizar para esta operação.

Corpo do Pedido

Name Necessário Tipo Description
permissionType True

permissionType

A permissão pedida
scope True

scope

O tipo de suporte de dados pedido
projectId

string

O ID do projeto
videoId

string

O ID do vídeo

Respostas

Name Tipo Description
200 OK

AccessToken

As propriedades do token de acesso da conta do Azure Video Indexer foram obtidas com êxito.
Other Status Codes

ErrorResponse

Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

Generate accessToken for account contributor
Generate accessToken for account reader
Generate accessToken for project contributor
Generate accessToken for project reader
Generate accessToken for video contributor
Generate accessToken for video reader

Generate accessToken for account contributor

Sample Request

POST https://management.azure.com/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer/generateAccessToken?api-version=2024-01-01

{
  "permissionType": "Contributor",
  "scope": "Account"
}

Sample Response

Status code:
200 
{
  "accessToken": "<jwt token of 1260 characters length>"
}

Generate accessToken for account reader

Sample Request

POST https://management.azure.com/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer/generateAccessToken?api-version=2024-01-01

{
  "permissionType": "Reader",
  "scope": "Account"
}

Sample Response

Status code:
200 
{
  "accessToken": "<jwt token of 1260 characters length>"
}

Generate accessToken for project contributor

Sample Request

POST https://management.azure.com/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer/generateAccessToken?api-version=2024-01-01

{
  "permissionType": "Contributor",
  "scope": "Project",
  "projectId": "07ec9e38d4"
}

Sample Response

Status code:
200 
{
  "accessToken": "<jwt token of 1260 characters length>"
}

Generate accessToken for project reader

Sample Request

POST https://management.azure.com/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer/generateAccessToken?api-version=2024-01-01

{
  "permissionType": "Reader",
  "scope": "Project",
  "projectId": "07ec9e38d4"
}

Sample Response

Status code:
200 
{
  "accessToken": "<jwt token of 1260 characters length>"
}

Generate accessToken for video contributor

Sample Request

POST https://management.azure.com/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer/generateAccessToken?api-version=2024-01-01

{
  "permissionType": "Contributor",
  "scope": "Video",
  "videoId": "07ec9e38d4"
}

Sample Response

Status code:
200 
{
  "accessToken": "<jwt token of 1260 characters length>"
}

Generate accessToken for video reader

Sample Request

POST https://management.azure.com/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer/generateAccessToken?api-version=2024-01-01

{
  "permissionType": "Reader",
  "scope": "Video",
  "videoId": "07ec9e38d4"
}

Sample Response

Status code:
200 
{
  "accessToken": "<jwt token of 1260 characters length>"
}

Definições

Name Description
AccessToken

Token de acesso do Video Indexer do Azure.
ErrorDefinition

Definição de erro.
ErrorResponse

Resposta de erro.
GenerateAccessTokenParameters

Parâmetros do pedido de geração de tokens de acesso
permissionType

A permissão pedida
scope

O tipo de suporte de dados pedido

AccessToken

Token de acesso do Video Indexer do Azure.

Name Tipo Description
accessToken

string

O token de acesso.

ErrorDefinition

Definição de erro.

Name Tipo Description
code

string

Código de erro específico do serviço que serve como subestado para o código de erro HTTP.
details

ErrorDefinition[]

Detalhes internos do erro.
message

string

Descrição do erro.

ErrorResponse

Resposta de erro.

Name Tipo Description
error

ErrorDefinition

Os detalhes do erro.

GenerateAccessTokenParameters

Parâmetros do pedido de geração de tokens de acesso

Name Tipo Description
permissionType

permissionType

A permissão pedida
projectId

string

O ID do projeto
scope

scope

O tipo de suporte de dados pedido
videoId

string

O ID do vídeo

permissionType

A permissão pedida

Name Tipo Description
Contributor

string

Reader

string

scope

O tipo de suporte de dados pedido

Name Tipo Description
Account

string

Project

string

Video

string