Generate - Access Token

  • Referenz
Service:
Azure Video Indexer
API Version:
2024-01-01

Generieren Sie ein Azure Video Indexer-Zugriffstoken.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
accountName
 path True

string

Der Name des Azure Video Indexer-Kontos.

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

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId
 path True

string

Hierbei handelt es sich um die ID des Zielabonnements.
api-version
 query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name Erforderlich Typ Beschreibung
permissionType True

permissionType

Die angeforderte Berechtigung
scope True

scope

Der angeforderte Medientyp
projectId

string

Die Projekt-ID
videoId

string

Video-ID

Antworten

Name Typ Beschreibung
200 OK

AccessToken

Die Zugriffstokeneigenschaften des Azure Video Indexer-Kontos wurden erfolgreich abgerufen.
Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name Beschreibung
AccessToken

Azure Video Indexer-Zugriffstoken.
ErrorDefinition

Fehlerdefinition.
ErrorResponse

Fehlerantwort.
GenerateAccessTokenParameters

Parameter der Zugriffstokengenerierungsanforderung
permissionType

Die angeforderte Berechtigung
scope

Der angeforderte Medientyp

AccessToken

Azure Video Indexer-Zugriffstoken.

Name Typ Beschreibung
accessToken

string

Zugriffstoken

ErrorDefinition

Fehlerdefinition.

Name Typ Beschreibung
code

string

Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient.
details

ErrorDefinition[]

Interne Fehlerdetails.
message

string

Beschreibung des Fehlers

ErrorResponse

Fehlerantwort.

Name Typ Beschreibung
error

ErrorDefinition

Die Fehlerdetails.

GenerateAccessTokenParameters

Parameter der Zugriffstokengenerierungsanforderung

Name Typ Beschreibung
permissionType

permissionType

Die angeforderte Berechtigung
projectId

string

Die Projekt-ID
scope

scope

Der angeforderte Medientyp
videoId

string

Video-ID

permissionType

Die angeforderte Berechtigung

Name Typ Beschreibung
Contributor

string

Reader

string

scope

Der angeforderte Medientyp

Name Typ Beschreibung
Account

string

Project

string

Video

string