Dela via

Generate - Access Token

  • Referens
Tjänst:
Azure Video Indexer
API-version:
2024-01-01

Generera en Åtkomsttoken för Azure Video Indexer.

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

URI-parametrar

Name I Obligatorisk Typ Description
accountName
 path True

string

minLength: 3
maxLength: 50
pattern: ^[A-Za-z0-9-]+$

Namnet på Azure Video Indexer-kontot.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId
 path True

string

minLength: 1

ID för målprenumerationen.
api-version
 query True

string

minLength: 1

DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name Obligatorisk Typ Description
permissionType True

permissionType

Den begärda behörigheten
scope True

scope

Den begärda medietypen
projectId

string

Projekt-ID
videoId

string

Video-ID:t

Svar

Name Typ Description
200 OK

AccessToken

Azure Video Indexer-kontots åtkomsttokenegenskaper har hämtats.
Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

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

Exempelbegäran

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

Exempelsvar

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

Generate accessToken for account reader

Exempelbegäran

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

Exempelsvar

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

Generate accessToken for project contributor

Exempelbegäran

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

Exempelsvar

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

Generate accessToken for project reader

Exempelbegäran

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

Exempelsvar

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

Generate accessToken for video contributor

Exempelbegäran

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

Exempelsvar

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

Generate accessToken for video reader

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
AccessToken

Åtkomsttoken för Azure Video Indexer.
ErrorDefinition

Feldefinition.
ErrorResponse

Felsvar.
GenerateAccessTokenParameters

Parametrar för åtkomsttokengenereringsbegäran
permissionType

Den begärda behörigheten
scope

Den begärda medietypen

AccessToken

Objekt

Åtkomsttoken för Azure Video Indexer.

Name Typ Description
accessToken

string

Åtkomsttoken.

ErrorDefinition

Objekt

Feldefinition.

Name Typ Description
code

string

Tjänstspecifik felkod som fungerar som understatus för HTTP-felkoden.
details

ErrorDefinition[]

Intern felinformation.
message

string

Beskrivning av felet.

ErrorResponse

Objekt

Felsvar.

Name Typ Description
error

ErrorDefinition

Felinformationen.

GenerateAccessTokenParameters

Objekt

Parametrar för åtkomsttokengenereringsbegäran

Name Typ Description
permissionType

permissionType

Den begärda behörigheten
projectId

string

Projekt-ID
scope

scope

Den begärda medietypen
videoId

string

Video-ID:t

permissionType

Uppräkning

Den begärda behörigheten

Värde Description
Contributor
Reader

scope

Uppräkning

Den begärda medietypen

Värde Description
Account
Project
Video