@datafire/azure_mediaservices_assets

Client library for Azure Media Services

Installation and Usage

npm install --save @datafire/azure_mediaservices_assets

let azure_mediaservices_assets = require('@datafire/azure_mediaservices_assets').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

This Swagger was generated by the API Framework.

Actions

Assets_List

List Assets in the Media Services account with optional filtering and ordering

azure_mediaservices_assets.Assets_List({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • api-version required string: The Version of the API to be used with the client request.
  • $filter string: Restricts the set of items returned.
  • $top integer: Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n.
  • $orderby string: Specifies the key by which the result collection should be ordered.

Output

• output AssetCollection

Assets_Delete

Deletes an Asset in the Media Services account

azure_mediaservices_assets.Assets_Delete({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "assetName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • assetName required string: The Asset name.
  • api-version required string: The Version of the API to be used with the client request.

Output

Output schema unknown

Assets_Get

Get the details of an Asset in the Media Services account

azure_mediaservices_assets.Assets_Get({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "assetName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • assetName required string: The Asset name.
  • api-version required string: The Version of the API to be used with the client request.

Output

• output Asset

Assets_Update

Updates an existing Asset in the Media Services account

azure_mediaservices_assets.Assets_Update({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "assetName": "",
  "parameters": {},
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • assetName required string: The Asset name.
  • parameters required Asset
  • api-version required string: The Version of the API to be used with the client request.

Output

• output Asset

Assets_CreateOrUpdate

Creates or updates an Asset in the Media Services account

azure_mediaservices_assets.Assets_CreateOrUpdate({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "assetName": "",
  "parameters": {},
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • assetName required string: The Asset name.
  • parameters required Asset
  • api-version required string: The Version of the API to be used with the client request.

Output

• output Asset

Assets_GetEncryptionKey

Gets the Asset storage encryption keys used to decrypt content created by version 2 of the Media Services API

azure_mediaservices_assets.Assets_GetEncryptionKey({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "assetName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • assetName required string: The Asset name.
  • api-version required string: The Version of the API to be used with the client request.

Output

• output AssetStorageEncryptionKey

Assets_ListContainerSas

Lists storage container URLs with shared access signatures (SAS) for uploading and downloading Asset content. The signatures are derived from the storage account keys.

azure_mediaservices_assets.Assets_ListContainerSas({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "assetName": "",
  "parameters": {},
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • resourceGroupName required string: The name of the resource group within the Azure subscription.
  • accountName required string: The Media Services account name.
  • assetName required string: The Asset name.
  • parameters required ListContainerSasInput
  • api-version required string: The Version of the API to be used with the client request.

Output

• output AssetContainerSas

Definitions

ApiError

• ApiError object: The API error.
  • error ODataError

Asset

• Asset object: An Asset.
  • properties AssetProperties
  • id string: Fully qualified resource ID for the resource.
  • name string: The name of the resource.
  • type string: The type of the resource.

AssetCollection

• AssetCollection object: A collection of Asset items.
  • @odata.nextLink string: A link to the next page of the collection (when the collection contains too many results to return in one response).
  • value array: A collection of Asset items.
    • items Asset

AssetContainerSas

• AssetContainerSas object: The Asset Storage container SAS URLs.
  • assetContainerSasUrls array: The list of Asset container SAS URLs.
    • items string

AssetProperties

• AssetProperties object: The Asset properties.
  • alternateId string: The alternate ID of the Asset.
  • assetId string: The Asset ID.
  • container string: The name of the asset blob container.
  • created string: The creation date of the Asset.
  • description string: The Asset description.
  • lastModified string: The last modified date of the Asset.
  • storageAccountName string: The name of the storage account.
  • storageEncryptionFormat string (values: None, MediaStorageClientEncryption): The Asset encryption format. One of None or MediaStorageEncryption.

AssetStorageEncryptionKey

• AssetStorageEncryptionKey object: The Asset Storage encryption key.
  • storageEncryptionKey string: The Asset storage encryption key.

ListContainerSasInput

• ListContainerSasInput object: The parameters to the list SAS request.
  • expiryTime string: The SAS URL expiration time. This must be less than 24 hours from the current time.
  • permissions string (values: Read, ReadWrite, ReadWriteDelete): The permissions to set on the SAS URL.

ODataError

• ODataError object: Information about an error.
  • code string: A language-independent error name.
  • details array: The error details.
    • items ODataError
  • message string: The error message.
  • target string: The target of the error (for example, the name of the property in error).