@datafire/azure_mediaservices_mediagraphs

Client library for Azure Media Services

Installation and Usage

npm install --save @datafire/azure_mediaservices_mediagraphs

let azure_mediaservices_mediagraphs = require('@datafire/azure_mediaservices_mediagraphs').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

MediaGraphs_List

Lists Media Graphs in the Media Services account

azure_mediaservices_mediagraphs.MediaGraphs_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.
  • $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.

Output

• output MediaGraphCollection

MediaGraphs_Delete

Deletes a Media Graph in the Media Services account

azure_mediaservices_mediagraphs.MediaGraphs_Delete({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "mediaGraphName": "",
  "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.
  • mediaGraphName required string: The Media Graph name.
  • api-version required string: The Version of the API to be used with the client request.

Output

Output schema unknown

MediaGraphs_Get

Get the details of a Media Graph in the Media Services account

azure_mediaservices_mediagraphs.MediaGraphs_Get({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "mediaGraphName": "",
  "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.
  • mediaGraphName required string: The Media Graph name.
  • api-version required string: The Version of the API to be used with the client request.

Output

• output MediaGraph

MediaGraphs_CreateOrUpdate

Create or update a Media Graph in the Media Services account

azure_mediaservices_mediagraphs.MediaGraphs_CreateOrUpdate({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "mediaGraphName": "",
  "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.
  • mediaGraphName required string: The Media Graph name.
  • parameters required MediaGraph
  • api-version required string: The Version of the API to be used with the client request.

Output

• output MediaGraph

OperationResults_Get

Get the operation result of a Media Graph in the Media Services account

azure_mediaservices_mediagraphs.OperationResults_Get({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "mediaGraphName": "",
  "operationId": "",
  "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.
  • mediaGraphName required string: The Media Graph name.
  • operationId required string: The operation ID
  • api-version required string: The Version of the API to be used with the client request.

Output

• output MediaGraphOperationResult

OperationsStatus_Get

Get the operation status of a Media Graph in the media services account

azure_mediaservices_mediagraphs.OperationsStatus_Get({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "mediaGraphName": "",
  "operationId": "",
  "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.
  • mediaGraphName required string: The Media Graph name.
  • operationId required string: The operation ID
  • api-version required string: The Version of the API to be used with the client request.

Output

• output MediaGraphOperationStatus

MediaGraphs_Start

Start a Media Graph in the Media Services account

azure_mediaservices_mediagraphs.MediaGraphs_Start({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "mediaGraphName": "",
  "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.
  • mediaGraphName required string: The Media Graph name.
  • api-version required string: The Version of the API to be used with the client request.

Output

Output schema unknown

MediaGraphs_Stop

Stop a Media Graph in the Media Services account

azure_mediaservices_mediagraphs.MediaGraphs_Stop({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "mediaGraphName": "",
  "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.
  • mediaGraphName required string: The Media Graph name.
  • api-version required string: The Version of the API to be used with the client request.

Output

Output schema unknown

Definitions

ApiError

• ApiError object: The API error.
  • error ODataError

MediaGraph

• MediaGraph object: The Media Graph.
  • properties MediaGraphProperties
  • id string: Fully qualified resource ID for the resource.
  • name string: The name of the resource.
  • type string: The type of the resource.

MediaGraphAssetSink

• MediaGraphAssetSink object: Asset sink
  • assetName required string: Asset name
  • @odata.type required string: The discriminator for derived types.
  • inputs required array: Sink inputs
    • items string
  • name required string: Sink name

MediaGraphCollection

• MediaGraphCollection object: A collection of MediaGraph 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 MediaGraph items.
    • items MediaGraph

MediaGraphOperationError

• MediaGraphOperationError object: The operation error
  • code string: The operation error code
  • message string: The operation error message

MediaGraphOperationResult

• MediaGraphOperationResult object: The result of the Media Graph operation

MediaGraphOperationStatus

• MediaGraphOperationStatus object: The status of the Media Graph operation
  • error MediaGraphOperationError
  • name required string: The name of the Media Graph operation
  • status string: The status of the Media Graph operation

MediaGraphProperties

• MediaGraphProperties object: Class for Media Graph properties
  • created string: Date the Media Graph was created
  • description string: Media Graph description
  • lastModified string: Date the Media Graph was last modified
  • sinks required array: Media Graph sinks
    • items MediaGraphSink
  • sources required array: Media Graph sources
    • items MediaGraphSource
  • state string (values: Running, Starting, Stopped, Stopping): Media Graph state

MediaGraphRtspSource

• MediaGraphRtspSource object: RTSP source
  • credentials MediaGraphUserCredentials
  • rtspUrl required string: RTSP URL
  • @odata.type required string: The discriminator for derived types.
  • name required string: Source name

MediaGraphSink

• MediaGraphSink object: Media Sink
  • @odata.type required string: The discriminator for derived types.
  • inputs required array: Sink inputs
    • items string
  • name required string: Sink name

MediaGraphSource

• MediaGraphSource object: Media source
  • @odata.type required string: The discriminator for derived types.
  • name required string: Source name

MediaGraphUserCredentials

• MediaGraphUserCredentials object: Credentials to authenticate to Media Graph sources
  • password required string: Password credential
  • username required string: User name

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).