Generate - Access Token

  • リファレンス
Service:
Azure Video Indexer
API Version:
2024-01-01

Azure Video Indexer アクセス トークンを生成します。

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

URI パラメーター

名前 / 必須 型 説明
accountName
 path True

string

Azure Video Indexer アカウントの名前。

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

string

リソース グループの名前。 名前の大文字と小文字は区別されます。
subscriptionId
 path True

string

ターゲット サブスクリプションの ID。
api-version
 query True

string

この操作に使用する API バージョン。

要求本文

名前 必須 型 説明
permissionType True

permissionType

要求されたアクセス許可
scope True

scope

要求されたメディアの種類
projectId

string

プロジェクト ID
videoId

string

ビデオ ID

応答

名前 型 説明
200 OK

AccessToken

Azure Video Indexer アカウントのアクセス トークンプロパティが正常に取得されました。
Other Status Codes

ErrorResponse

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前 説明
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>"
}

定義

名前 説明
AccessToken

Azure Video Indexer アクセス トークン。
ErrorDefinition

エラー定義。
ErrorResponse

エラー応答。
GenerateAccessTokenParameters

アクセス トークン生成要求のパラメーター
permissionType

要求されたアクセス許可
scope

要求されたメディアの種類

AccessToken

Azure Video Indexer アクセス トークン。

名前 型 説明
accessToken

string

アクセス トークン。

ErrorDefinition

エラー定義。

名前 型 説明
code

string

HTTP エラー コードのサブステータスとして機能するサービス固有のエラー コード。
details

ErrorDefinition[]

内部エラーの詳細。
message

string

エラーの説明。

ErrorResponse

エラー応答。

名前 型 説明
error

ErrorDefinition

エラーの詳細です。

GenerateAccessTokenParameters

アクセス トークン生成要求のパラメーター

名前 型 説明
permissionType

permissionType

要求されたアクセス許可
projectId

string

プロジェクト ID
scope

scope

要求されたメディアの種類
videoId

string

ビデオ ID

permissionType

要求されたアクセス許可

名前 型 説明
Contributor

string

Reader

string

scope

要求されたメディアの種類

名前 型 説明
Account

string

Project

string

Video

string