Generate - Access Token

  • Referensi
Service:
Azure Video Indexer
API Version:
2022-04-13-preview

Membuat token akses Azure Video Indexer.

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

Parameter URI

Name In Required Type Description
accountName
 path True
  • string

Nama akun Azure Video Indexer.

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

Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
subscriptionId
 path True
  • string

ID langganan target.
api-version
 query True
  • string

Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Name Required Type Description
permissionType True

Izin yang diminta
scope True

Jenis media yang diminta
projectId
  • string

ID proyek
videoId
  • string

ID video

Respons

Name Type Description
200 OK

Properti token akses akun Azure Video Indexer berhasil diambil.
400 Bad Request

Permintaan Buruk.
404 Not Found

Tidak Ditemukan
500 Internal Server Error

Kesalahan Server Internal
Other Status Codes

Konflik
Other Status Codes

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation meniru akun pengguna Anda

Contoh

Generate accessToken for account contributor
Generate accessToken for account reader
Generate accessToken for project contributor #1
Generate accessToken for project contributor #2
Generate accessToken for project reader #1
Generate accessToken for project reader #2
Generate accessToken for video contributor #1
Generate accessToken for video contributor #2
Generate accessToken for video reader #1
Generate accessToken for video reader #2

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=2022-04-13-preview

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

Sample Response

Status code:
200 
{
  "accessToken": "<jwt token of 1260 characters length>"
}
Status code:
400 
{
  "error": {
    "code": "INVALID_INPUT",
    "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found."
  }
}
Status code:
404 
{}
Status code:
409 
{
  "error": {
    "code": "ALREADY_EXISTS",
    "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists"
  }
}
Status code:
500 
{
  "error": {
    "code": "GENERAL",
    "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'."
  }
}

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=2022-04-13-preview

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

Sample Response

Status code:
200 
{
  "accessToken": "<jwt token of 1260 characters length>"
}
Status code:
400 
{
  "error": {
    "code": "INVALID_INPUT",
    "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found."
  }
}
Status code:
404 
{}
Status code:
409 
{
  "error": {
    "code": "ALREADY_EXISTS",
    "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists"
  }
}
Status code:
500 
{
  "error": {
    "code": "GENERAL",
    "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'."
  }
}

Generate accessToken for project contributor #1

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=2022-04-13-preview

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

Sample Response

Status code:
200 
{
  "accessToken": "<jwt token of 1260 characters length>"
}
Status code:
400 
{
  "error": {
    "code": "INVALID_INPUT",
    "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found."
  }
}
Status code:
404 
{
  "error": {
    "code": "BREAKDOWN_NOT_FOUND",
    "message": "Video/Project '07ec9e38d4' was not found"
  }
}
Status code:
409 
{
  "error": {
    "code": "ALREADY_EXISTS",
    "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists"
  }
}
Status code:
500 
{
  "error": {
    "code": "GENERAL",
    "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'."
  }
}

Generate accessToken for project contributor #2

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=2022-04-13-preview

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

Sample Response

Status code:
200 
{
  "accessToken": "<jwt token of 1260 characters length>"
}
Status code:
400 
{
  "error": {
    "code": "INVALID_INPUT",
    "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found."
  }
}
Status code:
404 
{
  "error": {
    "code": "INVALID_INPUT",
    "message": "Playlist '07ec9e38d4' does not belong to account '74h866ca-f74f-7963-a926-4712f5bc0123'. Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'"
  }
}
Status code:
409 
{
  "error": {
    "code": "ALREADY_EXISTS",
    "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists"
  }
}
Status code:
500 
{
  "error": {
    "code": "GENERAL",
    "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'."
  }
}

Generate accessToken for project reader #1

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=2022-04-13-preview

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

Sample Response

Status code:
200 
{
  "accessToken": "<jwt token of 1260 characters length>"
}
Status code:
400 
{
  "error": {
    "code": "INVALID_INPUT",
    "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found."
  }
}
Status code:
404 
{
  "error": {
    "code": "BREAKDOWN_NOT_FOUND",
    "message": "Video/Project '07ec9e38d4' was not found"
  }
}
Status code:
409 
{
  "error": {
    "code": "ALREADY_EXISTS",
    "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists"
  }
}
Status code:
500 
{
  "error": {
    "code": "GENERAL",
    "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'."
  }
}

Generate accessToken for project reader #2

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=2022-04-13-preview

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

Sample Response

Status code:
200 
{
  "accessToken": "<jwt token of 1260 characters length>"
}
Status code:
400 
{
  "error": {
    "code": "INVALID_INPUT",
    "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found."
  }
}
Status code:
404 
{
  "error": {
    "code": "INVALID_INPUT",
    "message": "Playlist '07ec9e38d4' does not belong to account '74h866ca-f74f-7963-a926-4712f5bc0123'. Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'"
  }
}
Status code:
409 
{
  "error": {
    "code": "ALREADY_EXISTS",
    "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists"
  }
}
Status code:
500 
{
  "error": {
    "code": "GENERAL",
    "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'."
  }
}

Generate accessToken for video contributor #1

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=2022-04-13-preview

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

Sample Response

Status code:
200 
{
  "accessToken": "<jwt token of 1260 characters length>"
}
Status code:
400 
{
  "error": {
    "code": "INVALID_INPUT",
    "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found."
  }
}
Status code:
404 
{
  "error": {
    "code": "BREAKDOWN_NOT_FOUND",
    "message": "Video/Project '07ec9e38d4' was not found"
  }
}
Status code:
409 
{
  "error": {
    "code": "ALREADY_EXISTS",
    "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists"
  }
}
Status code:
500 
{
  "error": {
    "code": "GENERAL",
    "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'."
  }
}

Generate accessToken for video contributor #2

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=2022-04-13-preview

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

Sample Response

Status code:
200 
{
  "accessToken": "<jwt token of 1260 characters length>"
}
Status code:
400 
{
  "error": {
    "code": "INVALID_INPUT",
    "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found."
  }
}
Status code:
404 
{
  "error": {
    "code": "INVALID_INPUT",
    "message": "Playlist '07ec9e38d4' does not belong to account '74h866ca-f74f-7963-a926-4712f5bc0123'. Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'"
  }
}
Status code:
409 
{
  "error": {
    "code": "ALREADY_EXISTS",
    "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists"
  }
}
Status code:
500 
{
  "error": {
    "code": "GENERAL",
    "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'."
  }
}

Generate accessToken for video reader #1

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=2022-04-13-preview

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

Sample Response

Status code:
200 
{
  "accessToken": "<jwt token of 1260 characters length>"
}
Status code:
400 
{
  "error": {
    "code": "INVALID_INPUT",
    "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found."
  }
}
Status code:
404 
{
  "error": {
    "code": "BREAKDOWN_NOT_FOUND",
    "message": "Video/Project '07ec9e38d4' was not found"
  }
}
Status code:
409 
{
  "error": {
    "code": "ALREADY_EXISTS",
    "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists"
  }
}
Status code:
500 
{
  "error": {
    "code": "GENERAL",
    "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'."
  }
}

Generate accessToken for video reader #2

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=2022-04-13-preview

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

Sample Response

Status code:
200 
{
  "accessToken": "<jwt token of 1260 characters length>"
}
Status code:
400 
{
  "error": {
    "code": "INVALID_INPUT",
    "message": "Account '/subscriptions/b04775c3-63fa-40f3-9430-139d2e5522d3/resourceGroups/contosto-videoanalyzer-rg/providers/Microsoft.Contoso/accounts/contosto-videoanalyzer' not found."
  }
}
Status code:
404 
{
  "error": {
    "code": "INVALID_INPUT",
    "message": "Playlist '07ec9e38d4' does not belong to account '74h866ca-f74f-7963-a926-4712f5bc0123'. Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'"
  }
}
Status code:
409 
{
  "error": {
    "code": "ALREADY_EXISTS",
    "message": "Account with '74f866ea-f74f-4103-a916-4742f8bc0009' already exists"
  }
}
Status code:
500 
{
  "error": {
    "code": "GENERAL",
    "message": "Trace id: '9677927b-ae6b-496g-1df8-9ec3048b4bf2'."
  }
}

Definisi

AccessToken

Token akses Azure Video Indexer.
ErrorDefinition

Definisi kesalahan.
ErrorResponse

Respons kesalahan.
GenerateAccessTokenParameters

Parameter permintaan pembuatan token akses
permissionType

Izin yang diminta
scope

Jenis media yang diminta

AccessToken

Token akses Azure Video Indexer.

Name Type Description
accessToken
  • string

Token akses.

ErrorDefinition

Definisi kesalahan.

Name Type Description
code
  • string

Kode kesalahan khusus layanan yang berfungsi sebagai substatus untuk kode kesalahan HTTP.
details

Detail kesalahan internal.
message
  • string

Deskripsi kesalahan.

ErrorResponse

Respons kesalahan.

Name Type Description
error

Detail kesalahan.

GenerateAccessTokenParameters

Parameter permintaan pembuatan token akses

Name Type Description
permissionType

Izin yang diminta
projectId
  • string

ID proyek
scope

Jenis media yang diminta
videoId
  • string

ID video

permissionType

Izin yang diminta

Name Type Description
Contributor
  • string
Reader
  • string

scope

Jenis media yang diminta

Name Type Description
Account
  • string
Project
  • string
Video
  • string