@datafire/azure_mediaservices_media

Client library for MediaServicesManagementClient

Installation and Usage

npm install --save @datafire/azure_mediaservices_media

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

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

Description

Media Services resource management APIs.

Actions

Operations_List

Lists all of the available Media Services REST API operations.

azure_mediaservices_media.Operations_List({
  "api-version": ""
}, context)

Input

• input object
  • api-version required string: Version of the API to be used with the client request. The current version is 2015-10-01.

Output

• output OperationListResult

MediaService_CheckNameAvailability

Checks whether the Media Service resource name is available. The name must be globally unique.

azure_mediaservices_media.MediaService_CheckNameAvailability({
  "subscriptionId": "",
  "api-version": "",
  "parameters": null
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • api-version required string: Version of the API to be used with the client request. The current version is 2015-10-01.
  • parameters required CheckNameAvailabilityInput

Output

• output CheckNameAvailabilityOutput

MediaService_ListByResourceGroup

Lists all of the Media Services in a resource group.

azure_mediaservices_media.MediaService_ListByResourceGroup({
  "subscriptionId": "",
  "api-version": "",
  "resourceGroupName": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • api-version required string: Version of the API to be used with the client request. The current version is 2015-10-01.
  • resourceGroupName required string: Name of the resource group within the Azure subscription.

Output

• output MediaServiceCollection

MediaService_Delete

Deletes a Media Service.

azure_mediaservices_media.MediaService_Delete({
  "subscriptionId": "",
  "api-version": "",
  "resourceGroupName": "",
  "mediaServiceName": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • api-version required string: Version of the API to be used with the client request. The current version is 2015-10-01.
  • resourceGroupName required string: Name of the resource group within the Azure subscription.
  • mediaServiceName required string: Name of the Media Service.

Output

Output schema unknown

MediaService_Get

Gets a Media Service.

azure_mediaservices_media.MediaService_Get({
  "subscriptionId": "",
  "api-version": "",
  "resourceGroupName": "",
  "mediaServiceName": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • api-version required string: Version of the API to be used with the client request. The current version is 2015-10-01.
  • resourceGroupName required string: Name of the resource group within the Azure subscription.
  • mediaServiceName required string: Name of the Media Service.

Output

• output MediaService

MediaService_Update

Updates a Media Service.

azure_mediaservices_media.MediaService_Update({
  "subscriptionId": "",
  "api-version": "",
  "resourceGroupName": "",
  "mediaServiceName": "",
  "parameters": null
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • api-version required string: Version of the API to be used with the client request. The current version is 2015-10-01.
  • resourceGroupName required string: Name of the resource group within the Azure subscription.
  • mediaServiceName required string: Name of the Media Service.
  • parameters required MediaService

Output

• output MediaService

MediaService_Create

Creates a Media Service.

azure_mediaservices_media.MediaService_Create({
  "subscriptionId": "",
  "api-version": "",
  "resourceGroupName": "",
  "mediaServiceName": "",
  "parameters": null
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • api-version required string: Version of the API to be used with the client request. The current version is 2015-10-01.
  • resourceGroupName required string: Name of the resource group within the Azure subscription.
  • mediaServiceName required string: Name of the Media Service.
  • parameters required MediaService

Output

• output MediaService

MediaService_ListKeys

Lists the keys for a Media Service.

azure_mediaservices_media.MediaService_ListKeys({
  "subscriptionId": "",
  "api-version": "",
  "resourceGroupName": "",
  "mediaServiceName": ""
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • api-version required string: Version of the API to be used with the client request. The current version is 2015-10-01.
  • resourceGroupName required string: Name of the resource group within the Azure subscription.
  • mediaServiceName required string: Name of the Media Service.

Output

• output ServiceKeys

MediaService_RegenerateKey

Regenerates a primary or secondary key for a Media Service.

azure_mediaservices_media.MediaService_RegenerateKey({
  "subscriptionId": "",
  "api-version": "",
  "resourceGroupName": "",
  "mediaServiceName": "",
  "parameters": null
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • api-version required string: Version of the API to be used with the client request. The current version is 2015-10-01.
  • resourceGroupName required string: Name of the resource group within the Azure subscription.
  • mediaServiceName required string: Name of the Media Service.
  • parameters required RegenerateKeyInput

Output

• output RegenerateKeyOutput

MediaService_SyncStorageKeys

Synchronizes storage account keys for a storage account associated with the Media Service account.

azure_mediaservices_media.MediaService_SyncStorageKeys({
  "subscriptionId": "",
  "api-version": "",
  "resourceGroupName": "",
  "mediaServiceName": "",
  "parameters": null
}, context)

Input

• input object
  • subscriptionId required string: The unique identifier for a Microsoft Azure subscription.
  • api-version required string: Version of the API to be used with the client request. The current version is 2015-10-01.
  • resourceGroupName required string: Name of the resource group within the Azure subscription.
  • mediaServiceName required string: Name of the Media Service.
  • parameters required SyncStorageKeysInput

Output

Output schema unknown

Definitions

ApiEndpoint

• ApiEndpoint object: The properties for a Media Services REST API endpoint.
  • endpoint string: The Media Services REST endpoint.
  • majorVersion string: The version of Media Services REST API.

ApiError

• ApiError object: The error returned from a failed Media Services REST API call.
  • code string: Error code.
  • message string: Error message.

CheckNameAvailabilityInput

• CheckNameAvailabilityInput object: The request body for CheckNameAvailability API.
  • name required string: The name of the resource. A name must be globally unique.
  • type required ResourceType

CheckNameAvailabilityOutput

• CheckNameAvailabilityOutput object: The response body for CheckNameAvailability API.
  • message string: Specifies the detailed reason if the name is not available.
  • nameAvailable boolean: Specifies if the name is available.
  • reason string (values: None, Invalid, AlreadyExists): Specifies the reason if the name is not available.

MediaService

• MediaService object: The properties of a Media Service resource.
  • properties MediaServiceProperties
  • id string: The id of the resource.
  • location string: The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth).
  • name string: The name of the resource.
  • tags object: Tags to help categorize the resource in the Azure portal.
  • type string: The type of the resource

MediaServiceCollection

• MediaServiceCollection object: The collection of Media Service resources.
  • value array: The collection of Media Service resources.
    • items MediaService

MediaServiceProperties

• MediaServiceProperties object: The additional properties of a Media Service resource.
  • apiEndpoints array: Read-only property that lists the Media Services REST API endpoints for this resource. If supplied on a PUT or PATCH, the value will be ignored.
    • items ApiEndpoint
  • storageAccounts array: The storage accounts for this resource.
    • items StorageAccount

Operation

• Operation object: A Media Services REST API operation
  • display object: The object that represents the operation.
    • operation string: Operation type: Read, write, delete, etc.
    • provider string: Service provider: Microsoft.Media
    • resource string: Resource on which the operation is performed: Invoice, etc.
  • name string: Operation name: {provider}/{resource}/{operation}

OperationListResult

• OperationListResult object: Result of the request to list Media Services operations.
  • nextLink string: URL to get the next set of operation list results if there are any.
  • value array: List of Media Services operations supported by the Microsoft.Media resource provider.
    • items Operation

RegenerateKeyInput

• RegenerateKeyInput object: The request body for a RegenerateKey API.
  • keyType required string (values: Primary, Secondary): The keyType indicating which key you want to regenerate, Primary or Secondary.

RegenerateKeyOutput

• RegenerateKeyOutput object: The response body for a RegenerateKey API.
  • key string: The new value of either the primary or secondary key.

Resource

• Resource object: The Azure Resource Manager resource.
  • id string: The id of the resource.
  • location string: The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth).
  • name string: The name of the resource.
  • tags object: Tags to help categorize the resource in the Azure portal.
  • type string: The type of the resource

ResourceType

• ResourceType string (values: mediaservices): Type of MediaService resource.

ServiceKeys

• ServiceKeys object: The response body for a ListKeys API.
  • primaryAuthEndpoint string: The primary authorization endpoint.
  • primaryKey string: The primary key for the Media Service resource.
  • scope string: The authorization scope.
  • secondaryAuthEndpoint string: The secondary authorization endpoint.
  • secondaryKey string: The secondary key for the Media Service resource.

StorageAccount

• StorageAccount object: The properties of a storage account associated with this resource.
  • id required string: The id of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts (isPrimary false).
  • isPrimary required boolean: Is this storage account resource the primary storage account for the Media Service resource. Blob only storage must set this to false.

SyncStorageKeysInput

• SyncStorageKeysInput object: The request body for a SyncStorageKeys API.
  • id required string: The id of the storage account resource.