{ "swagger": "2.0", "info": { "version": "2025-04-01", "title": "vi", "description": "Microsoft Azure Video Indexer" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/providers/Microsoft.VideoIndexer/operations": { "get": { "tags": [ "Operations" ], "description": "Lists all of the available Azure Video Indexer provider operations.", "operationId": "Operations_List", "x-ms-examples": { "List operations": { "$ref": "./examples/ViOperationsList.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.VideoIndexer/checkNameAvailability": { "post": { "tags": [ "NameAvailability" ], "operationId": "Accounts_CheckNameAvailability", "description": "Checks that the Video Indexer account name is valid and is not already in use.", "x-ms-examples": { "Check free account name availability": { "$ref": "./examples/ViAccountCheckNameAvailabilityFree.json" }, "Check taken account name availability": { "$ref": "./examples/ViAccountCheckNameAvailabilityTaken.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "name": "checkNameAvailabilityParameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AccountCheckNameAvailabilityParameters" }, "description": "The name of the Video Indexer account. Name must be unique globally" } ], "responses": { "200": { "description": "OK - Operation to check the Video Indexer account name availability was successful. Ok does not indicate the name is available, the body of the response does.", "schema": { "$ref": "#/definitions/CheckNameAvailabilityResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.VideoIndexer/accounts": { "get": { "tags": [ "Accounts" ], "operationId": "Accounts_List", "description": "List all Azure Video Indexer accounts available under the subscription", "x-ms-examples": { "List accounts": { "$ref": "./examples/ViAccountsList.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AccountList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts": { "get": { "tags": [ "Accounts" ], "operationId": "Accounts_ListByResourceGroup", "description": "List all Azure Video Indexer accounts available under the resource group", "x-ms-examples": { "List accounts by resource group": { "$ref": "./examples/ViAccountsListByResourceGroup.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AccountList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}": { "get": { "tags": [ "Accounts" ], "operationId": "Accounts_Get", "description": "Gets the properties of an Azure Video Indexer account.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/AccountNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The Azure Video Indexer account properties were retrieved successfully.", "schema": { "$ref": "#/definitions/Account" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get account": { "$ref": "./examples/ViAccountGet.json" } } }, "patch": { "tags": [ "Accounts" ], "operationId": "Accounts_Update", "x-ms-long-running-operation": false, "description": "Updates the properties of an existing Azure Video Indexer account.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/AccountNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "parameters", "description": "The parameters to provide for the current Azure Video Indexer account.", "schema": { "$ref": "#/definitions/AccountPatch" } } ], "responses": { "200": { "description": "The resource was updated successfully.", "schema": { "$ref": "#/definitions/Account" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Patch account with system assigned Mi": { "$ref": "./examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json" }, "Patch account with user assigned Mi": { "$ref": "./examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json" } } }, "put": { "tags": [ "Accounts" ], "operationId": "Accounts_CreateOrUpdate", "description": "Creates or updates an Azure Video Indexer account.", "x-ms-long-running-operation": false, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/AccountNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "parameters", "description": "The parameters to provide for the Azure Video Indexer account.", "schema": { "$ref": "#/definitions/Account" } } ], "responses": { "200": { "description": "The resource was successfully updated.", "schema": { "$ref": "#/definitions/Account" } }, "201": { "description": "The resource was successfully created.", "schema": { "$ref": "#/definitions/Account" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update account with system assigned Mi": { "$ref": "./examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json" }, "Create or update account with user assigned Mi": { "$ref": "./examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json" }, "Connect classic account to arm account using system assigned Mi": { "$ref": "./examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json" }, "Connect classic account to arm account using user assigned Mi": { "$ref": "./examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json" } } }, "delete": { "tags": [ "Accounts" ], "operationId": "Accounts_Delete", "description": "Delete an Azure Video Indexer account.", "x-ms-long-running-operation": false, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/AccountNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The Azure Video Indexer account was successfully deleted." }, "202": { "description": "The Azure Video Indexer account will be deleted asynchronously." }, "204": { "description": "The Azure Video Indexer account does not exist." }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete account": { "$ref": "./examples/ViAccountDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/generateAccessToken": { "post": { "tags": [ "AccessToken" ], "operationId": "Generate_AccessToken", "description": "Generate an Azure Video Indexer access token.", "x-ms-examples": { "Generate accessToken for video contributor": { "$ref": "./examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json" }, "Generate accessToken for video reader": { "$ref": "./examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json" }, "Generate accessToken for project contributor": { "$ref": "./examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json" }, "Generate accessToken for project reader": { "$ref": "./examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json" }, "Generate accessToken for account contributor": { "$ref": "./examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json" }, "Generate accessToken for account reader": { "$ref": "./examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/AccountNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "parameters", "x-ms-client-flatten": true, "description": "The parameters for generating access token", "schema": { "$ref": "#/definitions/GenerateAccessTokenParameters" } } ], "responses": { "200": { "description": "The Azure Video Indexer account's access token properties were retrieved successfully.", "schema": { "$ref": "#/definitions/AccessToken" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/generateRestrictedViewerAccessToken": { "post": { "tags": [ "AccessToken" ], "operationId": "Generate_RestrictedViewerAccessToken", "description": "Generate an Azure Video Indexer restricted viewer access token.", "x-ms-examples": { "Generate restricted viewer accessToken for video": { "$ref": "./examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json" }, "Generate restricted viewer accessToken for project": { "$ref": "./examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json" }, "Generate restricted viewer accessToken for account": { "$ref": "./examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/AccountNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "parameters", "x-ms-client-flatten": true, "description": "The parameters for generating restricted viewer access token", "schema": { "$ref": "#/definitions/GenerateRestrictedViewerAccessTokenParameters" } } ], "responses": { "200": { "description": "The Azure Video Indexer account's access token properties were retrieved successfully.", "schema": { "$ref": "#/definitions/AccessToken" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/generateExtensionAccessToken": { "post": { "tags": [ "Arc" ], "operationId": "Generate_ExtensionAccessToken", "description": "Generate an Azure Video Indexer access token.", "x-ms-examples": { "Generate accessToken for video contributor": { "$ref": "./examples/ViGenerateExtensionAccessToken/ViGenerateVideoContributerAccessToken.json" }, "Generate accessToken for video reader": { "$ref": "./examples/ViGenerateExtensionAccessToken/ViGenerateVideoReaderAccessToken.json" }, "Generate accessToken for account contributor": { "$ref": "./examples/ViGenerateExtensionAccessToken/ViGenerateAccountContributerAccessToken.json" }, "Generate accessToken for account reader": { "$ref": "./examples/ViGenerateExtensionAccessToken/ViGenerateAccountReaderAccessToken.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/AccountNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "parameters", "x-ms-client-flatten": true, "description": "The parameters for generating access token", "schema": { "$ref": "#/definitions/GenerateExtensionAccessTokenParameters" } } ], "responses": { "200": { "description": "The Azure Video Indexer account's access token properties were retrieved successfully.", "schema": { "$ref": "#/definitions/AccessToken" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/generateExtensionRestrictedViewerAccessToken": { "post": { "tags": [ "Arc" ], "operationId": "Generate_ExtensionRestrictedViewerAccessToken", "description": "Generate an Azure Video Indexer restricted viewer access token.", "x-ms-examples": { "Generate restricted viewer accessToken for video #1": { "$ref": "./examples/ViGenerateExtensionRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json" }, "Generate restricted viewer accessToken for account": { "$ref": "./examples/ViGenerateExtensionRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/AccountNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "in": "body", "name": "parameters", "x-ms-client-flatten": true, "description": "The parameters for generating restricted viewer access token", "schema": { "$ref": "#/definitions/GenerateExtensionRestrictedViewerAccessTokenParameters" } } ], "responses": { "200": { "description": "The Azure Video Indexer account's access token properties were retrieved successfully.", "schema": { "$ref": "#/definitions/AccessToken" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/privateEndpointConnections": { "get": { "tags": [ "PrivateEndpointConnections" ], "description": "List all private endpoint connections in a Video Indexer account.", "operationId": "PrivateEndpointConnections_ListByAccount", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/AccountNameParameter" } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnectionListResult" } }, "default": { "description": "Error response describing the reason for operation failure.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateEndpointConnectionList": { "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnection_ListByAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": { "get": { "tags": [ "PrivateEndpointConnections" ], "description": "Get the specified private endpoint connection associated with the Video Indexer account.", "operationId": "PrivateEndpointConnections_Get", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/AccountNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" } }, "default": { "description": "Error response describing the reason for operation failure.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateEndpointConnectionGet": { "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnection_Get.json" } } }, "put": { "tags": [ "PrivateEndpointConnections" ], "description": "Update the state of specified private endpoint connection associated with the Video Indexer account.", "operationId": "PrivateEndpointConnections_CreateOrUpdate", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/AccountNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" } } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" } }, "201": { "description": "The request was successful; the operation will complete asynchronously.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" } }, "default": { "description": "Error response describing the reason for operation failure.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateEndpointConnectionCreateOrUpdate": { "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnection_CreateOrUpdate.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" } }, "delete": { "tags": [ "PrivateEndpointConnections" ], "description": "Deletes the specified private endpoint connection associated with the Video Indexer account.", "operationId": "PrivateEndpointConnections_Delete", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/AccountNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" } ], "responses": { "202": { "description": "The request was successful; the operation will complete asynchronously.", "headers": { "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, "204": { "description": "The private endpoint connection has been disconnected." }, "default": { "description": "Error response describing the reason for operation failure.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateEndpointConnectionDelete": { "$ref": "./examples/PrivateEndpointConnections/PrivateEndpointConnection_Delete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/privateLinkResources": { "get": { "tags": [ "PrivateLinkResources" ], "description": "List all private link resources in a Video Indexer account.", "operationId": "PrivateLinkResources_ListByAccount", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/AccountNameParameter" } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateLinkResourceListResult" } }, "default": { "description": "Error response describing the reason for operation failure.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateLinkResourcesList": { "$ref": "./examples/PrivateLinkResources/PrivateLinkResources_ListByAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/privateLinkResources/{groupId}": { "get": { "tags": [ "PrivateLinkResources" ], "description": "Get the private link resource with the specified group Id associated with the Video Indexer account.", "operationId": "PrivateLinkResources_Get", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/AccountNameParameter" }, { "$ref": "#/parameters/GroupIdParameter" } ], "responses": { "200": { "description": "The request was successful; the request was well-formed and received properly.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResource" } }, "default": { "description": "Error response describing the reason for operation failure.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateLinkResourcesGet": { "$ref": "./examples/PrivateLinkResources/PrivateLinkResources_Get.json" } } } } }, "definitions": { "Tags": { "type": "object", "description": "Resource tags", "properties": { "tags": { "type": "object", "additionalProperties": { "type": "string" }, "x-ms-mutability": [ "read", "create", "update" ], "description": "Resource tags" } } }, "Account": { "description": "An Azure Video Indexer account.", "type": "object", "properties": { "properties": { "description": "List of account properties", "type": "object", "x-ms-client-flatten": true, "$ref": "#/definitions/AccountPropertiesForPutRequest" }, "identity": { "$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" }, "systemData": { "readOnly": true, "description": "The system meta data relating to this resource.", "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "AccountPatch": { "type": "object", "description": "Azure Video Indexer account", "properties": { "properties": { "description": "List of account properties", "type": "object", "x-ms-client-flatten": true, "$ref": "#/definitions/AccountPropertiesForPatchRequest" }, "identity": { "$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" } }, "allOf": [ { "$ref": "#/definitions/Tags" } ] }, "AccountPropertiesForPutRequest": { "description": "Azure Video Indexer account properties", "type": "object", "properties": { "tenantId": { "description": "The account's tenant id", "type": "string", "readOnly": true, "example": "2b9bcf6d-39d5-460a-a6bb-7b40b7ccf139" }, "accountId": { "description": "The account's data-plane ID. This can be set only when connecting an existing classic account", "type": "string", "default": "00000000-0000-0000-0000-000000000000", "example": "3575690b-a569-449c-ab7b-11020f948f76" }, "accountName": { "description": "The account's name", "type": "string", "readOnly": true, "example": "contoso-videoAnalyzer" }, "storageServices": { "description": "The storage services details", "type": "object", "$ref": "#/definitions/StorageServicesForPutRequest" }, "openAiServices": { "description": "The openAi services details", "type": "object", "$ref": "#/definitions/OpenAiServicesForPutRequest" }, "totalSecondsIndexed": { "description": "An integer representing the total seconds that have been indexed on the account", "type": "integer", "format": "int32", "readOnly": true }, "totalMinutesIndexed": { "description": "An integer representing the total minutes that have been indexed on the account", "type": "integer", "format": "int64", "readOnly": true }, "publicNetworkAccess": { "description": "Whether or not public network access is allowed for the account.", "enum": [ "Enabled", "Disabled" ], "type": "string", "x-ms-enum": { "name": "PublicNetworkAccess", "modelAsString": true } }, "privateEndpointConnections": { "description": "List of private endpoint connections associated with the account.", "type": "array", "items": { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" } }, "provisioningState": { "readOnly": true, "type": "string", "description": "Gets the status of the account at the time the operation was called.", "enum": [ "Succeeded", "Failed", "Canceled", "Accepted", "Provisioning", "Deleting" ], "x-ms-enum": { "name": "provisioningState", "modelAsString": true } } } }, "AccountPropertiesForPatchRequest": { "description": "Azure Video Indexer account properties", "type": "object", "properties": { "tenantId": { "description": "The account's tenant id", "type": "string", "readOnly": true, "example": "2b9bcf6d-39d5-460a-a6bb-7b40b7ccf139" }, "accountId": { "description": "The account's data-plane ID", "readOnly": true, "type": "string", "example": "3575690b-a569-449c-ab7b-11020f948f76" }, "storageServices": { "description": "The storage services details", "type": "object", "$ref": "#/definitions/StorageServicesForPatchRequest" }, "openAiServices": { "description": "The openAi services details", "type": "object", "$ref": "#/definitions/OpenAiServicesForPatchRequest" }, "publicNetworkAccess": { "description": "Whether or not public network access is allowed for the account.", "enum": [ "Enabled", "Disabled" ], "type": "string", "x-ms-enum": { "name": "PublicNetworkAccess", "modelAsString": true } }, "privateEndpointConnections": { "description": "List of private endpoint connections associated with the account.", "type": "array", "items": { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" } }, "provisioningState": { "readOnly": true, "type": "string", "description": "Gets the status of the account at the time the operation was called.", "enum": [ "Succeeded", "Failed", "Canceled", "Accepted", "Provisioning", "Deleting" ], "x-ms-enum": { "name": "provisioningState", "modelAsString": true } } } }, "AccountList": { "properties": { "value": { "readOnly": true, "type": "array", "items": { "$ref": "#/definitions/Account" }, "description": "List of accounts and their properties." }, "nextLink": { "type": "string", "description": "URL to get the next set of operation list results if there are any.", "example": "https://management.azure.com/{accountsOperation}?api-version={version}&%24skiptoken={token}" } }, "description": "The list operation response, that contains the data pools and their properties.", "type": "object" }, "GenerateAccessTokenParameters": { "description": "Access token generation request's parameters", "type": "object", "required": [ "permissionType", "scope" ], "properties": { "permissionType": { "type": "string", "description": "The requested permission", "enum": [ "Contributor", "Reader" ], "x-ms-enum": { "name": "permissionType", "modelAsString": true } }, "scope": { "type": "string", "description": "The requested media type", "enum": [ "Video", "Account", "Project" ], "x-ms-enum": { "name": "scope", "modelAsString": true } }, "videoId": { "description": "The video ID", "type": "string", "example": "07ec9e38d4" }, "projectId": { "description": "The project ID", "type": "string" } } }, "GenerateRestrictedViewerAccessTokenParameters": { "description": "Restricted viewer access token generation request's parameters", "type": "object", "required": [ "scope" ], "properties": { "scope": { "type": "string", "description": "The requested media type", "enum": [ "Video", "Account", "Project" ], "x-ms-enum": { "name": "scope", "modelAsString": true } }, "videoId": { "description": "The video ID", "type": "string", "example": "07ec9e38d4" }, "projectId": { "description": "The project ID", "type": "string" } } }, "GenerateExtensionAccessTokenParameters": { "description": "Access token generation request's parameters", "type": "object", "required": [ "permissionType", "scope", "extensionId" ], "properties": { "permissionType": { "type": "string", "description": "The requested permission", "enum": [ "Contributor", "Reader" ], "x-ms-enum": { "name": "permissionType", "modelAsString": true } }, "scope": { "type": "string", "description": "The requested media type", "enum": [ "Video", "Account", "Project" ], "x-ms-enum": { "name": "scope", "modelAsString": true } }, "extensionId": { "description": "The extension's resource ID", "type": "string", "example": "/subscriptions/39ks012-8546-4da5-g6w0-8c3cb76dd930/resourceGroups/yl-arc/providers/Microsoft.Kubernetes/ConnectedClusters/yl-arc/providers/Microsoft.KubernetesConfiguration/extensions/exampleid" }, "videoId": { "description": "The video ID", "type": "string", "example": "07ec9e38d4" }, "tokenLifetimeInSeconds": { "description": "Lifetime of the access token (in seconds). Default value: 3600 (1 hour), Max value: 43200 (12 hours). Setting this value is enabled for tokens in 'Video' scope.", "type": "integer", "format": "int32", "example": 3600 } } }, "GenerateExtensionRestrictedViewerAccessTokenParameters": { "description": "Restricted viewer access token generation request's parameters", "type": "object", "required": [ "scope", "extensionId" ], "properties": { "scope": { "type": "string", "description": "The requested media type", "enum": [ "Video", "Account", "Project" ], "x-ms-enum": { "name": "scope", "modelAsString": true } }, "extensionId": { "description": "The extension's resource ID", "type": "string", "example": "/subscriptions/39ks012-8546-4da5-g6w0-8c3cb76dd930/resourceGroups/yl-arc/providers/Microsoft.Kubernetes/ConnectedClusters/yl-arc/providers/Microsoft.KubernetesConfiguration/extensions/exampleid" }, "videoId": { "description": "The video ID", "type": "string", "example": "07ec9e38d4" }, "tokenLifetimeInSeconds": { "description": "Lifetime of the access token (in seconds). Default value: 3600 (1 hour), Max value: 43200 (12 hours). Setting this value is enabled for tokens in 'Video' scope.", "type": "integer", "format": "int32", "example": 3600 } } }, "StorageServicesForPutRequest": { "description": "The storage services details", "type": "object", "properties": { "resourceId": { "type": "string", "format": "arm-id", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Storage/storageAccounts" } ] }, "description": "The storage services resource id", "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoAnalyzer-ms" }, "userAssignedIdentity": { "type": "string", "description": "The user assigned identity to be used to grant permissions", "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoAnalyzer-mi" } } }, "OpenAiServicesForPutRequest": { "description": "The openAi services details", "type": "object", "properties": { "resourceId": { "type": "string", "format": "arm-id", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.CognitiveServices/accounts" } ] }, "description": "The openAi services resource id", "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" }, "userAssignedIdentity": { "type": "string", "description": "The user assigned identity to be used to grant permissions", "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoAnalyzer-mi" } } }, "StorageServicesForPatchRequest": { "description": "The storage services details", "type": "object", "properties": { "userAssignedIdentity": { "type": "string", "description": "The user assigned identity to be used to grant permissions", "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoAnalyzer-mi" } } }, "OpenAiServicesForPatchRequest": { "description": "The openAi services details", "type": "object", "properties": { "resourceId": { "type": "string", "format": "arm-id", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.CognitiveServices/accounts" } ] }, "description": "The openAi services resource id", "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" }, "userAssignedIdentity": { "type": "string", "description": "The user assigned identity to be used to grant permissions", "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoAnalyzer-mi" } } }, "AccessToken": { "description": "Azure Video Indexer access token.", "type": "object", "properties": { "accessToken": { "type": "string", "readOnly": true, "description": "The access token.", "x-ms-secret": true, "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJPbmxpbmUgSldUIEJ1aWxkZXIiLCJpYXQiOjE2MjI0NDc3MzMsImV4cCI6MTY1Mzk4MzczMywiYXVkIjoid3d3LmV4YW1wbGUuY29tIiwic3ViIjoianJvY2tldEBleGFtcGxlLmNvbSIsIkdpdmVuTmFtZSI6IkpvaG5ueSIsIlN1cm5hbWUiOiJSb2NrZXQiLCJFbWFpbCI6Impyb2NrZXRAZXhhbXBsZS5jb20iLCJSb2xlIjpbIk1hbmFnZXIiLCJQcm9qZWN0IEFkbWluaXN0cmF0b3IiXX0" } } }, "Operation": { "description": "Operation detail payload", "type": "object", "properties": { "name": { "description": "Name of the operation", "readOnly": true, "type": "string", "example": "Microsoft.VideoIndexer/accounts/read" }, "isDataAction": { "description": "Indicates whether the operation is a data action", "readOnly": true, "type": "boolean", "example": false }, "actionType": { "description": "Indicates the action type.", "readOnly": true, "type": "string", "example": "Internal" }, "display": { "$ref": "#/definitions/OperationDisplay", "readOnly": true, "description": "Display of the operation" }, "origin": { "description": "Origin of the operation", "readOnly": true, "type": "string", "example": "user" } } }, "OperationDisplay": { "description": "Operation display payload", "type": "object", "properties": { "provider": { "description": "Resource provider of the operation", "readOnly": true, "type": "string", "example": "Microsoft Azure Video Indexer" }, "resource": { "description": "Resource of the operation", "readOnly": true, "type": "string", "example": "accounts" }, "operation": { "description": "Localized friendly name for the operation", "readOnly": true, "type": "string", "example": "Read accounts" }, "description": { "description": "Localized friendly description for the operation", "readOnly": true, "type": "string", "example": "Read accounts details" } } }, "OperationListResult": { "description": "Available operations of the service.", "type": "object", "properties": { "value": { "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/Operation" }, "description": "List of operations supported by the Resource Provider." }, "nextLink": { "type": "string", "readOnly": true, "description": "URL to get the next set of operation list results if there are any.", "example": "https://management.azure.com/{operation}?api-version={version}&%24skiptoken={token}" } } }, "AccountCheckNameAvailabilityParameters": { "type": "object", "properties": { "name": { "type": "string", "description": "The VideoIndexer account name." }, "type": { "type": "string", "enum": [ "Microsoft.VideoIndexer/accounts" ], "x-ms-enum": { "name": "Type", "modelAsString": true }, "description": "The type of resource, Microsoft.VideoIndexer/accounts" } }, "required": [ "name", "type" ], "description": "The parameters used to check the availability of the Video Indexer account name." }, "CheckNameAvailabilityResult": { "type": "object", "properties": { "nameAvailable": { "readOnly": true, "type": "boolean", "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken." }, "reason": { "readOnly": true, "type": "string", "description": "Gets the reason that a Video Indexer account name could not be used. The Reason element is only returned if NameAvailable is false.", "enum": [ "AlreadyExists" ], "x-ms-enum": { "name": "Reason", "modelAsString": true } }, "message": { "readOnly": true, "type": "string", "description": "Gets an error message explaining the Reason value in more detail." } }, "description": "The CheckNameAvailability operation response." } }, "parameters": { "AccountNameParameter": { "name": "accountName", "in": "path", "required": true, "type": "string", "description": "The name of the Azure Video Indexer account.", "pattern": "^[A-Za-z0-9-]+$", "maxLength": 50, "minLength": 3, "x-ms-parameter-location": "method" }, "GroupIdParameter": { "name": "groupId", "in": "path", "required": true, "type": "string", "description": "The group ID of the private link resource.", "x-ms-parameter-location": "method" } } }