Share via

Generate - Access Token

  • 參考
Service:
Azure Video Indexer
API Version:
2024-01-01

產生 Azure 影片索引器存取令牌。

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

URI 參數

名稱 位於 必要 類型 Description
accountName
 path True

string

Azure 影片索引器帳戶的名稱。

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

string

資源群組的名稱。 名稱不區分大小寫。
subscriptionId
 path True

string

目標訂用帳戶的標識碼。
api-version
 query True

string

用於此作業的 API 版本。

要求本文

名稱 必要 類型 Description
permissionType True

permissionType

要求的許可權
scope True

scope

要求的媒體類型
projectId

string

項目標識碼
videoId

string

影片識別碼

回應

名稱 類型 Description
200 OK

AccessToken

已成功擷取 Azure 影片索引器帳戶的存取令牌屬性。
Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

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>"
}

定義

名稱 Description
AccessToken

Azure 影片索引器存取令牌。
ErrorDefinition

錯誤定義。
ErrorResponse

錯誤回應。
GenerateAccessTokenParameters

存取令牌產生要求的參數
permissionType

要求的許可權
scope

要求的媒體類型

AccessToken

Azure 影片索引器存取令牌。

名稱 類型 Description
accessToken

string

存取權杖。

ErrorDefinition

錯誤定義。

名稱 類型 Description
code

string

服務特定的錯誤碼，可作為 HTTP 錯誤碼的子狀態。
details

ErrorDefinition[]

內部錯誤詳細數據。
message

string

錯誤的描述。

ErrorResponse

錯誤回應。

名稱 類型 Description
error

ErrorDefinition

錯誤詳細資料。

GenerateAccessTokenParameters

存取令牌產生要求的參數

名稱 類型 Description
permissionType

permissionType

要求的許可權
projectId

string

項目標識碼
scope

scope

要求的媒體類型
videoId

string

影片識別碼

permissionType

要求的許可權

名稱 類型 Description
Contributor

string

Reader

string

scope

要求的媒體類型

名稱 類型 Description
Account

string

Project

string

Video

string