In this article:
List Jobs
Lists all of the Jobs for the Transform.
GET https://{{api-endpoint}}/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs?api-version={{api-version}}
With optional parameters:
GET https://{{api-endpoint}}/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs?api-version={{api-version}}&$filter={$filter}&$orderby={$orderby}
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
accountName |
path | True | string | The Media Services account name. |
resourceGroupName |
path | True | string | The name of the resource group within the Azure subscription. |
subscriptionId |
path | True | string | The unique identifier for a Microsoft Azure subscription. |
transformName |
path | True | string | The Transform name. |
api-version |
query | True | string | The version of the API to be used with the client request. |
$filter |
query | string | Restricts the set of items returned. | |
$orderby |
query | string | Specifies the key by which the result collection should be ordered. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | JobCollection | OK |
| Other Status Codes | ErrorResponse | Detailed error information. |
Examples
Lists all of the Jobs for the Transform
| Technology | Sample request |
|---|---|
| HTTP |
GET https://{{api-endpoint}}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaServices/contosomedia/transforms/exampleTransform/jobs?api-version={{api-version}}
|
| Java |
/**
* Samples for Jobs List.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all.
* json
*/
/**
* Sample code: Lists all of the Jobs for the Transform.
*
* @param manager Entry point to MediaServicesManager.
*/
public static void
listsAllOfTheJobsForTheTransform(com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
manager.jobs().list("contosoresources", "contosomedia", "exampleTransform", null, null,
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| Python |
from azure.identity import DefaultAzureCredential
from azure.mgmt.media import AzureMediaServices
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-media
# USAGE
python jobslistall.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = AzureMediaServices(
credential=DefaultAzureCredential(),
subscription_id="00000000-0000-0000-0000-000000000000",
)
response = client.jobs.list(
resource_group_name="contosoresources",
account_name="contosomedia",
transform_name="exampleTransform",
)
for item in response:
print(item)
# x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| Go |
package armmediaservices_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mediaservices/armmediaservices/v3"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e7bf3adfa2d5e5cdbb804eec35279501794f461c/specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all.json
func ExampleJobsClient_NewListPager_listsAllOfTheJobsForTheTransform() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmediaservices.NewClientFactory("", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewJobsClient().NewListPager("contosoresources", "contosomedia", "exampleTransform", &armmediaservices.JobsClientListOptions{Filter: nil,
Orderby: nil,
})
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.JobCollection = armmediaservices.JobCollection{
// Value: []*armmediaservices.Job{
// {
// Name: to.Ptr("job1"),
// Type: to.Ptr("Microsoft.Media/mediaservices/transforms/jobs"),
// ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1"),
// Properties: &armmediaservices.JobProperties{
// CorrelationData: map[string]*string{
// },
// Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// Input: &armmediaservices.JobInputs{
// ODataType: to.Ptr("#Microsoft.Media.JobInputs"),
// Inputs: []armmediaservices.JobInputClassification{
// &armmediaservices.JobInputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobInputAsset"),
// Files: []*string{
// },
// InputDefinitions: []armmediaservices.InputDefinitionClassification{
// },
// AssetName: to.Ptr("job1-InputAsset"),
// }},
// },
// LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// Outputs: []armmediaservices.JobOutputClassification{
// &armmediaservices.JobOutputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobOutputAsset"),
// Label: to.Ptr("example-custom-label"),
// Progress: to.Ptr[int32](0),
// State: to.Ptr(armmediaservices.JobStateQueued),
// AssetName: to.Ptr("job1-OutputAsset"),
// }},
// Priority: to.Ptr(armmediaservices.PriorityLow),
// State: to.Ptr(armmediaservices.JobStateQueued),
// },
// SystemData: &armmediaservices.SystemData{
// CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// CreatedBy: to.Ptr("contoso@microsoft.com"),
// CreatedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// LastModifiedBy: to.Ptr("contoso@microsoft.com"),
// LastModifiedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// },
// },
// {
// Name: to.Ptr("job2"),
// Type: to.Ptr("Microsoft.Media/mediaservices/transforms/jobs"),
// ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2"),
// Properties: &armmediaservices.JobProperties{
// CorrelationData: map[string]*string{
// },
// Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// Input: &armmediaservices.JobInputs{
// ODataType: to.Ptr("#Microsoft.Media.JobInputs"),
// Inputs: []armmediaservices.JobInputClassification{
// &armmediaservices.JobInputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobInputAsset"),
// Files: []*string{
// },
// InputDefinitions: []armmediaservices.InputDefinitionClassification{
// },
// AssetName: to.Ptr("job2-InputAsset"),
// }},
// },
// LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// Outputs: []armmediaservices.JobOutputClassification{
// &armmediaservices.JobOutputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobOutputAsset"),
// Label: to.Ptr("example-custom-label"),
// Progress: to.Ptr[int32](50),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:32.246Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateProcessing),
// AssetName: to.Ptr("job2-OutputAsset"),
// }},
// Priority: to.Ptr(armmediaservices.PriorityLow),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:32.246Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateProcessing),
// },
// SystemData: &armmediaservices.SystemData{
// CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// CreatedBy: to.Ptr("contoso@microsoft.com"),
// CreatedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// LastModifiedBy: to.Ptr("contoso@microsoft.com"),
// LastModifiedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// },
// },
// {
// Name: to.Ptr("job3"),
// Type: to.Ptr("Microsoft.Media/mediaservices/transforms/jobs"),
// ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3"),
// Properties: &armmediaservices.JobProperties{
// CorrelationData: map[string]*string{
// },
// Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:14:32.246Z"); return t}()),
// Input: &armmediaservices.JobInputs{
// ODataType: to.Ptr("#Microsoft.Media.JobInputs"),
// Inputs: []armmediaservices.JobInputClassification{
// &armmediaservices.JobInputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobInputAsset"),
// Files: []*string{
// },
// InputDefinitions: []armmediaservices.InputDefinitionClassification{
// },
// AssetName: to.Ptr("job3-InputAsset"),
// }},
// },
// LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// Outputs: []armmediaservices.JobOutputClassification{
// &armmediaservices.JobOutputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobOutputAsset"),
// EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:14:32.246Z"); return t}()),
// Label: to.Ptr("example-custom-label"),
// Progress: to.Ptr[int32](100),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:32.246Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateFinished),
// AssetName: to.Ptr("job3-OutputAsset"),
// }},
// Priority: to.Ptr(armmediaservices.PriorityLow),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:32.246Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateFinished),
// },
// SystemData: &armmediaservices.SystemData{
// CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// CreatedBy: to.Ptr("contoso@microsoft.com"),
// CreatedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// LastModifiedBy: to.Ptr("contoso@microsoft.com"),
// LastModifiedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| JavaScript |
const { AzureMediaServices } = require("@azure/arm-mediaservices");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Lists all of the Jobs for the Transform.
*
* @summary Lists all of the Jobs for the Transform.
* x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all.json
*/
async function listsAllOfTheJobsForTheTransform() {
const subscriptionId =
process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contosoresources";
const accountName = "contosomedia";
const transformName = "exampleTransform";
const credential = new DefaultAzureCredential();
const client = new AzureMediaServices(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.jobs.list(resourceGroupName, accountName, transformName)) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| .NET |
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Media;
using Azure.ResourceManager.Media.Models;
// Generated from example definition: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all.json
// this example is just showing the usage of "Jobs_List" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this MediaTransformResource created on azure
// for more information of creating MediaTransformResource, please refer to the document of MediaTransformResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "contosoresources";
string accountName = "contosomedia";
string transformName = "exampleTransform";
ResourceIdentifier mediaTransformResourceId = MediaTransformResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, transformName);
MediaTransformResource mediaTransform = client.GetMediaTransformResource(mediaTransformResourceId);
// get the collection of this MediaJobResource
MediaJobCollection collection = mediaTransform.GetMediaJobs();
// invoke the operation and iterate over the result
await foreach (MediaJobResource item in collection.GetAllAsync())
{
// the variable item is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
MediaJobData resourceData = item.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}
Console.WriteLine($"Succeeded");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
Sample response
Status code: 200
{
"value": [
{
"name": "job1",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1",
"type": "Microsoft.Media/mediaservices/transforms/jobs",
"properties": {
"created": "2021-06-01T00:00:00Z",
"state": "Queued",
"input": {
"@odata.type": "#Microsoft.Media.JobInputs",
"inputs": [
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
"inputDefinitions": [],
"assetName": "job1-InputAsset"
}
]
},
"lastModified": "2021-06-01T00:00:00Z",
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
"state": "Queued",
"progress": 0,
"label": "example-custom-label",
"assetName": "job1-OutputAsset"
}
],
"priority": "Low",
"correlationData": {}
},
"systemData": {
"createdBy": "contoso@microsoft.com",
"createdByType": "User",
"createdAt": "2021-06-01T00:00:00Z",
"lastModifiedBy": "contoso@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-01T00:00:00Z"
}
},
{
"name": "job2",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2",
"type": "Microsoft.Media/mediaservices/transforms/jobs",
"properties": {
"created": "2021-06-01T00:00:00Z",
"state": "Processing",
"input": {
"@odata.type": "#Microsoft.Media.JobInputs",
"inputs": [
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
"inputDefinitions": [],
"assetName": "job2-InputAsset"
}
]
},
"lastModified": "2021-06-01T00:00:00Z",
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
"state": "Processing",
"progress": 50,
"label": "example-custom-label",
"startTime": "2022-10-17T23:04:32.2462651Z",
"assetName": "job2-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
"startTime": "2022-10-17T23:04:32.2462651Z"
},
"systemData": {
"createdBy": "contoso@microsoft.com",
"createdByType": "User",
"createdAt": "2021-06-01T00:00:00Z",
"lastModifiedBy": "contoso@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-01T00:00:00Z"
}
},
{
"name": "job3",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3",
"type": "Microsoft.Media/mediaservices/transforms/jobs",
"properties": {
"created": "2021-06-01T00:00:00Z",
"state": "Finished",
"input": {
"@odata.type": "#Microsoft.Media.JobInputs",
"inputs": [
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
"inputDefinitions": [],
"assetName": "job3-InputAsset"
}
]
},
"lastModified": "2021-06-01T00:00:00Z",
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
"state": "Finished",
"progress": 100,
"label": "example-custom-label",
"startTime": "2022-10-17T23:04:32.2462651Z",
"endTime": "2022-10-17T23:14:32.2462651Z",
"assetName": "job3-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
"startTime": "2022-10-17T23:04:32.2462651Z",
"endTime": "2022-10-17T23:14:32.2462651Z"
},
"systemData": {
"createdBy": "contoso@microsoft.com",
"createdByType": "User",
"createdAt": "2021-06-01T00:00:00Z",
"lastModifiedBy": "contoso@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-01T00:00:00Z"
}
}
]
}
Lists Jobs for the Transform filter by created.
| Technology | Sample request |
|---|---|
| HTTP |
GET https://{{api-endpoint}}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaServices/contosomedia/transforms/exampleTransform/jobs?api-version={{api-version}}&$filter=properties/created ge 2021-06-01T00:00:10.0000000Z and properties/created le 2021-06-01T00:00:20.0000000Z&$orderby=properties/created
|
| Java |
/**
* Samples for Jobs List.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-
* filter-by-created.json
*/
/**
* Sample code: Lists Jobs for the Transform filter by created.
*
* @param manager Entry point to MediaServicesManager.
*/
public static void
listsJobsForTheTransformFilterByCreated(com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
manager.jobs().list("contosoresources", "contosomedia", "exampleTransform",
"properties/created ge 2021-06-01T00:00:10.0000000Z and properties/created le 2021-06-01T00:00:20.0000000Z",
"properties/created", com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| Python |
from azure.identity import DefaultAzureCredential
from azure.mgmt.media import AzureMediaServices
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-media
# USAGE
python jobslistallfilterbycreated.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = AzureMediaServices(
credential=DefaultAzureCredential(),
subscription_id="00000000-0000-0000-0000-000000000000",
)
response = client.jobs.list(
resource_group_name="contosoresources",
account_name="contosomedia",
transform_name="exampleTransform",
)
for item in response:
print(item)
# x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-created.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| Go |
package armmediaservices_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mediaservices/armmediaservices/v3"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e7bf3adfa2d5e5cdbb804eec35279501794f461c/specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-created.json
func ExampleJobsClient_NewListPager_listsJobsForTheTransformFilterByCreated() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmediaservices.NewClientFactory("", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewJobsClient().NewListPager("contosoresources", "contosomedia", "exampleTransform", &armmediaservices.JobsClientListOptions{Filter: to.Ptr("properties/created ge 2021-06-01T00:00:10.0000000Z and properties/created le 2021-06-01T00:00:20.0000000Z"),
Orderby: to.Ptr("properties/created"),
})
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.JobCollection = armmediaservices.JobCollection{
// Value: []*armmediaservices.Job{
// {
// Name: to.Ptr("job2"),
// Type: to.Ptr("Microsoft.Media/mediaservices/transforms/jobs"),
// ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2"),
// Properties: &armmediaservices.JobProperties{
// CorrelationData: map[string]*string{
// },
// Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:10.000Z"); return t}()),
// Input: &armmediaservices.JobInputs{
// ODataType: to.Ptr("#Microsoft.Media.JobInputs"),
// Inputs: []armmediaservices.JobInputClassification{
// &armmediaservices.JobInputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobInputAsset"),
// Files: []*string{
// },
// InputDefinitions: []armmediaservices.InputDefinitionClassification{
// },
// AssetName: to.Ptr("job2-InputAsset"),
// }},
// },
// LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:10.000Z"); return t}()),
// Outputs: []armmediaservices.JobOutputClassification{
// &armmediaservices.JobOutputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobOutputAsset"),
// Label: to.Ptr("example-custom-label"),
// Progress: to.Ptr[int32](50),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:33.233Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateProcessing),
// AssetName: to.Ptr("job2-OutputAsset"),
// }},
// Priority: to.Ptr(armmediaservices.PriorityLow),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:33.233Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateProcessing),
// },
// SystemData: &armmediaservices.SystemData{
// CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:10.000Z"); return t}()),
// CreatedBy: to.Ptr("contoso@microsoft.com"),
// CreatedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:10.000Z"); return t}()),
// LastModifiedBy: to.Ptr("contoso@microsoft.com"),
// LastModifiedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// },
// },
// {
// Name: to.Ptr("job3"),
// Type: to.Ptr("Microsoft.Media/mediaservices/transforms/jobs"),
// ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3"),
// Properties: &armmediaservices.JobProperties{
// CorrelationData: map[string]*string{
// },
// Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:20.000Z"); return t}()),
// EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:14:33.233Z"); return t}()),
// Input: &armmediaservices.JobInputs{
// ODataType: to.Ptr("#Microsoft.Media.JobInputs"),
// Inputs: []armmediaservices.JobInputClassification{
// &armmediaservices.JobInputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobInputAsset"),
// Files: []*string{
// },
// InputDefinitions: []armmediaservices.InputDefinitionClassification{
// },
// AssetName: to.Ptr("job3-InputAsset"),
// }},
// },
// LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:20.000Z"); return t}()),
// Outputs: []armmediaservices.JobOutputClassification{
// &armmediaservices.JobOutputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobOutputAsset"),
// EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:14:33.233Z"); return t}()),
// Label: to.Ptr("example-custom-label"),
// Progress: to.Ptr[int32](100),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:33.233Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateFinished),
// AssetName: to.Ptr("job3-OutputAsset"),
// }},
// Priority: to.Ptr(armmediaservices.PriorityLow),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:33.233Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateFinished),
// },
// SystemData: &armmediaservices.SystemData{
// CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:20.000Z"); return t}()),
// CreatedBy: to.Ptr("contoso@microsoft.com"),
// CreatedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:20.000Z"); return t}()),
// LastModifiedBy: to.Ptr("contoso@microsoft.com"),
// LastModifiedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| JavaScript |
const { AzureMediaServices } = require("@azure/arm-mediaservices");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Lists all of the Jobs for the Transform.
*
* @summary Lists all of the Jobs for the Transform.
* x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-created.json
*/
async function listsJobsForTheTransformFilterByCreated() {
const subscriptionId =
process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contosoresources";
const accountName = "contosomedia";
const transformName = "exampleTransform";
const filter =
"properties/created ge 2021-06-01T00:00:10.0000000Z and properties/created le 2021-06-01T00:00:20.0000000Z";
const orderby = "properties/created";
const options = { filter, orderby };
const credential = new DefaultAzureCredential();
const client = new AzureMediaServices(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.jobs.list(resourceGroupName, accountName, transformName, options)) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| .NET |
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Media;
using Azure.ResourceManager.Media.Models;
// Generated from example definition: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-created.json
// this example is just showing the usage of "Jobs_List" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this MediaTransformResource created on azure
// for more information of creating MediaTransformResource, please refer to the document of MediaTransformResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "contosoresources";
string accountName = "contosomedia";
string transformName = "exampleTransform";
ResourceIdentifier mediaTransformResourceId = MediaTransformResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, transformName);
MediaTransformResource mediaTransform = client.GetMediaTransformResource(mediaTransformResourceId);
// get the collection of this MediaJobResource
MediaJobCollection collection = mediaTransform.GetMediaJobs();
// invoke the operation and iterate over the result
string filter = "properties/created ge 2021-06-01T00:00:10.0000000Z and properties/created le 2021-06-01T00:00:20.0000000Z";
string orderby = "properties/created";
await foreach (MediaJobResource item in collection.GetAllAsync(filter: filter, orderby: orderby))
{
// the variable item is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
MediaJobData resourceData = item.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}
Console.WriteLine($"Succeeded");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
Sample response
Status code: 200
{
"value": [
{
"name": "job2",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2",
"type": "Microsoft.Media/mediaservices/transforms/jobs",
"properties": {
"created": "2021-06-01T00:00:10Z",
"state": "Processing",
"input": {
"@odata.type": "#Microsoft.Media.JobInputs",
"inputs": [
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
"inputDefinitions": [],
"assetName": "job2-InputAsset"
}
]
},
"lastModified": "2021-06-01T00:00:10Z",
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
"state": "Processing",
"progress": 50,
"label": "example-custom-label",
"startTime": "2022-10-17T23:04:33.2334355Z",
"assetName": "job2-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
"startTime": "2022-10-17T23:04:33.2334355Z"
},
"systemData": {
"createdBy": "contoso@microsoft.com",
"createdByType": "User",
"createdAt": "2021-06-01T00:00:10Z",
"lastModifiedBy": "contoso@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-01T00:00:10Z"
}
},
{
"name": "job3",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3",
"type": "Microsoft.Media/mediaservices/transforms/jobs",
"properties": {
"created": "2021-06-01T00:00:20Z",
"state": "Finished",
"input": {
"@odata.type": "#Microsoft.Media.JobInputs",
"inputs": [
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
"inputDefinitions": [],
"assetName": "job3-InputAsset"
}
]
},
"lastModified": "2021-06-01T00:00:20Z",
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
"state": "Finished",
"progress": 100,
"label": "example-custom-label",
"startTime": "2022-10-17T23:04:33.2334355Z",
"endTime": "2022-10-17T23:14:33.2334355Z",
"assetName": "job3-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
"startTime": "2022-10-17T23:04:33.2334355Z",
"endTime": "2022-10-17T23:14:33.2334355Z"
},
"systemData": {
"createdBy": "contoso@microsoft.com",
"createdByType": "User",
"createdAt": "2021-06-01T00:00:20Z",
"lastModifiedBy": "contoso@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-01T00:00:20Z"
}
}
]
}
Lists Jobs for the Transform filter by lastmodified.
| Technology | Sample request |
|---|---|
| HTTP |
GET https://{{api-endpoint}}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaServices/contosomedia/transforms/exampleTransform/jobs?api-version={{api-version}}&$filter=properties/lastmodified ge 2021-06-01T00:00:10.0000000Z and properties/lastmodified le 2021-06-01T00:00:20.0000000Z&$orderby=properties/lastmodified desc
|
| Java |
/**
* Samples for Jobs List.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-
* filter-by-lastmodified.json
*/
/**
* Sample code: Lists Jobs for the Transform filter by lastmodified.
*
* @param manager Entry point to MediaServicesManager.
*/
public static void listsJobsForTheTransformFilterByLastmodified(
com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
manager.jobs().list("contosoresources", "contosomedia", "exampleTransform",
"properties/lastmodified ge 2021-06-01T00:00:10.0000000Z and properties/lastmodified le 2021-06-01T00:00:20.0000000Z",
"properties/lastmodified desc", com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| Python |
from azure.identity import DefaultAzureCredential
from azure.mgmt.media import AzureMediaServices
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-media
# USAGE
python jobslistallfilterbylastmodified.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = AzureMediaServices(
credential=DefaultAzureCredential(),
subscription_id="00000000-0000-0000-0000-000000000000",
)
response = client.jobs.list(
resource_group_name="contosoresources",
account_name="contosomedia",
transform_name="exampleTransform",
)
for item in response:
print(item)
# x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-lastmodified.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| Go |
package armmediaservices_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mediaservices/armmediaservices/v3"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e7bf3adfa2d5e5cdbb804eec35279501794f461c/specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-lastmodified.json
func ExampleJobsClient_NewListPager_listsJobsForTheTransformFilterByLastmodified() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmediaservices.NewClientFactory("", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewJobsClient().NewListPager("contosoresources", "contosomedia", "exampleTransform", &armmediaservices.JobsClientListOptions{Filter: to.Ptr("properties/lastmodified ge 2021-06-01T00:00:10.0000000Z and properties/lastmodified le 2021-06-01T00:00:20.0000000Z"),
Orderby: to.Ptr("properties/lastmodified desc"),
})
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.JobCollection = armmediaservices.JobCollection{
// Value: []*armmediaservices.Job{
// {
// Name: to.Ptr("job3"),
// Type: to.Ptr("Microsoft.Media/mediaservices/transforms/jobs"),
// ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3"),
// Properties: &armmediaservices.JobProperties{
// CorrelationData: map[string]*string{
// },
// Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:20.000Z"); return t}()),
// EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:14:33.362Z"); return t}()),
// Input: &armmediaservices.JobInputs{
// ODataType: to.Ptr("#Microsoft.Media.JobInputs"),
// Inputs: []armmediaservices.JobInputClassification{
// &armmediaservices.JobInputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobInputAsset"),
// Files: []*string{
// },
// InputDefinitions: []armmediaservices.InputDefinitionClassification{
// },
// AssetName: to.Ptr("job3-InputAsset"),
// }},
// },
// LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:20.000Z"); return t}()),
// Outputs: []armmediaservices.JobOutputClassification{
// &armmediaservices.JobOutputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobOutputAsset"),
// EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:14:33.362Z"); return t}()),
// Label: to.Ptr("example-custom-label"),
// Progress: to.Ptr[int32](100),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:33.362Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateFinished),
// AssetName: to.Ptr("job3-OutputAsset"),
// }},
// Priority: to.Ptr(armmediaservices.PriorityLow),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:33.362Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateFinished),
// },
// SystemData: &armmediaservices.SystemData{
// CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:20.000Z"); return t}()),
// CreatedBy: to.Ptr("contoso@microsoft.com"),
// CreatedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:20.000Z"); return t}()),
// LastModifiedBy: to.Ptr("contoso@microsoft.com"),
// LastModifiedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// },
// },
// {
// Name: to.Ptr("job2"),
// Type: to.Ptr("Microsoft.Media/mediaservices/transforms/jobs"),
// ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2"),
// Properties: &armmediaservices.JobProperties{
// CorrelationData: map[string]*string{
// },
// Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:10.000Z"); return t}()),
// Input: &armmediaservices.JobInputs{
// ODataType: to.Ptr("#Microsoft.Media.JobInputs"),
// Inputs: []armmediaservices.JobInputClassification{
// &armmediaservices.JobInputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobInputAsset"),
// Files: []*string{
// },
// InputDefinitions: []armmediaservices.InputDefinitionClassification{
// },
// AssetName: to.Ptr("job2-InputAsset"),
// }},
// },
// LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:10.000Z"); return t}()),
// Outputs: []armmediaservices.JobOutputClassification{
// &armmediaservices.JobOutputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobOutputAsset"),
// Label: to.Ptr("example-custom-label"),
// Progress: to.Ptr[int32](50),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:33.362Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateProcessing),
// AssetName: to.Ptr("job2-OutputAsset"),
// }},
// Priority: to.Ptr(armmediaservices.PriorityLow),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:33.362Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateProcessing),
// },
// SystemData: &armmediaservices.SystemData{
// CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:10.000Z"); return t}()),
// CreatedBy: to.Ptr("contoso@microsoft.com"),
// CreatedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:10.000Z"); return t}()),
// LastModifiedBy: to.Ptr("contoso@microsoft.com"),
// LastModifiedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| JavaScript |
const { AzureMediaServices } = require("@azure/arm-mediaservices");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Lists all of the Jobs for the Transform.
*
* @summary Lists all of the Jobs for the Transform.
* x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-lastmodified.json
*/
async function listsJobsForTheTransformFilterByLastmodified() {
const subscriptionId =
process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contosoresources";
const accountName = "contosomedia";
const transformName = "exampleTransform";
const filter =
"properties/lastmodified ge 2021-06-01T00:00:10.0000000Z and properties/lastmodified le 2021-06-01T00:00:20.0000000Z";
const orderby = "properties/lastmodified desc";
const options = { filter, orderby };
const credential = new DefaultAzureCredential();
const client = new AzureMediaServices(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.jobs.list(resourceGroupName, accountName, transformName, options)) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| .NET |
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Media;
using Azure.ResourceManager.Media.Models;
// Generated from example definition: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-lastmodified.json
// this example is just showing the usage of "Jobs_List" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this MediaTransformResource created on azure
// for more information of creating MediaTransformResource, please refer to the document of MediaTransformResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "contosoresources";
string accountName = "contosomedia";
string transformName = "exampleTransform";
ResourceIdentifier mediaTransformResourceId = MediaTransformResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, transformName);
MediaTransformResource mediaTransform = client.GetMediaTransformResource(mediaTransformResourceId);
// get the collection of this MediaJobResource
MediaJobCollection collection = mediaTransform.GetMediaJobs();
// invoke the operation and iterate over the result
string filter = "properties/lastmodified ge 2021-06-01T00:00:10.0000000Z and properties/lastmodified le 2021-06-01T00:00:20.0000000Z";
string orderby = "properties/lastmodified desc";
await foreach (MediaJobResource item in collection.GetAllAsync(filter: filter, orderby: orderby))
{
// the variable item is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
MediaJobData resourceData = item.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}
Console.WriteLine($"Succeeded");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
Sample response
Status code: 200
{
"value": [
{
"name": "job3",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3",
"type": "Microsoft.Media/mediaservices/transforms/jobs",
"properties": {
"created": "2021-06-01T00:00:20Z",
"state": "Finished",
"input": {
"@odata.type": "#Microsoft.Media.JobInputs",
"inputs": [
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
"inputDefinitions": [],
"assetName": "job3-InputAsset"
}
]
},
"lastModified": "2021-06-01T00:00:20Z",
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
"state": "Finished",
"progress": 100,
"label": "example-custom-label",
"startTime": "2022-10-17T23:04:33.3623605Z",
"endTime": "2022-10-17T23:14:33.3623605Z",
"assetName": "job3-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
"startTime": "2022-10-17T23:04:33.3623605Z",
"endTime": "2022-10-17T23:14:33.3623605Z"
},
"systemData": {
"createdBy": "contoso@microsoft.com",
"createdByType": "User",
"createdAt": "2021-06-01T00:00:20Z",
"lastModifiedBy": "contoso@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-01T00:00:20Z"
}
},
{
"name": "job2",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2",
"type": "Microsoft.Media/mediaservices/transforms/jobs",
"properties": {
"created": "2021-06-01T00:00:10Z",
"state": "Processing",
"input": {
"@odata.type": "#Microsoft.Media.JobInputs",
"inputs": [
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
"inputDefinitions": [],
"assetName": "job2-InputAsset"
}
]
},
"lastModified": "2021-06-01T00:00:10Z",
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
"state": "Processing",
"progress": 50,
"label": "example-custom-label",
"startTime": "2022-10-17T23:04:33.3623605Z",
"assetName": "job2-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
"startTime": "2022-10-17T23:04:33.3623605Z"
},
"systemData": {
"createdBy": "contoso@microsoft.com",
"createdByType": "User",
"createdAt": "2021-06-01T00:00:10Z",
"lastModifiedBy": "contoso@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-01T00:00:10Z"
}
}
]
}
Lists Jobs for the Transform filter by name and state.
| Technology | Sample request |
|---|---|
| HTTP |
GET https://{{api-endpoint}}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaServices/contosomedia/transforms/exampleTransform/jobs?api-version={{api-version}}&$filter=name eq 'job3' and properties/state eq Microsoft.Media.JobState'finished'
|
| Java |
/**
* Samples for Jobs List.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-
* filter-by-name-and-state.json
*/
/**
* Sample code: Lists Jobs for the Transform filter by name and state.
*
* @param manager Entry point to MediaServicesManager.
*/
public static void listsJobsForTheTransformFilterByNameAndState(
com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
manager.jobs().list("contosoresources", "contosomedia", "exampleTransform",
"name eq 'job3' and properties/state eq Microsoft.Media.JobState'finished'", null,
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| Python |
from azure.identity import DefaultAzureCredential
from azure.mgmt.media import AzureMediaServices
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-media
# USAGE
python jobslistallfilterbynameandstate.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = AzureMediaServices(
credential=DefaultAzureCredential(),
subscription_id="00000000-0000-0000-0000-000000000000",
)
response = client.jobs.list(
resource_group_name="contosoresources",
account_name="contosomedia",
transform_name="exampleTransform",
)
for item in response:
print(item)
# x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-name-and-state.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| Go |
package armmediaservices_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mediaservices/armmediaservices/v3"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e7bf3adfa2d5e5cdbb804eec35279501794f461c/specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-name-and-state.json
func ExampleJobsClient_NewListPager_listsJobsForTheTransformFilterByNameAndState() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmediaservices.NewClientFactory("", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewJobsClient().NewListPager("contosoresources", "contosomedia", "exampleTransform", &armmediaservices.JobsClientListOptions{Filter: to.Ptr("name eq 'job3' and properties/state eq Microsoft.Media.JobState'finished'"),
Orderby: nil,
})
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.JobCollection = armmediaservices.JobCollection{
// Value: []*armmediaservices.Job{
// {
// Name: to.Ptr("job3"),
// Type: to.Ptr("Microsoft.Media/mediaservices/transforms/jobs"),
// ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3"),
// Properties: &armmediaservices.JobProperties{
// CorrelationData: map[string]*string{
// },
// Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:14:33.110Z"); return t}()),
// Input: &armmediaservices.JobInputs{
// ODataType: to.Ptr("#Microsoft.Media.JobInputs"),
// Inputs: []armmediaservices.JobInputClassification{
// &armmediaservices.JobInputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobInputAsset"),
// Files: []*string{
// },
// InputDefinitions: []armmediaservices.InputDefinitionClassification{
// },
// AssetName: to.Ptr("job3-InputAsset"),
// }},
// },
// LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// Outputs: []armmediaservices.JobOutputClassification{
// &armmediaservices.JobOutputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobOutputAsset"),
// EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:14:33.110Z"); return t}()),
// Label: to.Ptr("example-custom-label"),
// Progress: to.Ptr[int32](100),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:33.110Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateFinished),
// AssetName: to.Ptr("job3-OutputAsset"),
// }},
// Priority: to.Ptr(armmediaservices.PriorityLow),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:33.110Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateFinished),
// },
// SystemData: &armmediaservices.SystemData{
// CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// CreatedBy: to.Ptr("contoso@microsoft.com"),
// CreatedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// LastModifiedBy: to.Ptr("contoso@microsoft.com"),
// LastModifiedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| JavaScript |
const { AzureMediaServices } = require("@azure/arm-mediaservices");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Lists all of the Jobs for the Transform.
*
* @summary Lists all of the Jobs for the Transform.
* x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-name-and-state.json
*/
async function listsJobsForTheTransformFilterByNameAndState() {
const subscriptionId =
process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contosoresources";
const accountName = "contosomedia";
const transformName = "exampleTransform";
const filter = "name eq 'job3' and properties/state eq Microsoft.Media.JobState'finished'";
const options = { filter };
const credential = new DefaultAzureCredential();
const client = new AzureMediaServices(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.jobs.list(resourceGroupName, accountName, transformName, options)) {
resArray.push(item);
}
console.log(resArray);
}}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| .NET |
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Media;
using Azure.ResourceManager.Media.Models;
// Generated from example definition: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-name-and-state.json
// this example is just showing the usage of "Jobs_List" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this MediaTransformResource created on azure
// for more information of creating MediaTransformResource, please refer to the document of MediaTransformResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "contosoresources";
string accountName = "contosomedia";
string transformName = "exampleTransform";
ResourceIdentifier mediaTransformResourceId = MediaTransformResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, transformName);
MediaTransformResource mediaTransform = client.GetMediaTransformResource(mediaTransformResourceId);
// get the collection of this MediaJobResource
MediaJobCollection collection = mediaTransform.GetMediaJobs();
// invoke the operation and iterate over the result
string filter = "name eq 'job3' and properties/state eq Microsoft.Media.JobState'finished'";
await foreach (MediaJobResource item in collection.GetAllAsync(filter: filter))
{
// the variable item is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
MediaJobData resourceData = item.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}
Console.WriteLine($"Succeeded");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
Sample response
Status code: 200
{
"value": [
{
"name": "job3",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3",
"type": "Microsoft.Media/mediaservices/transforms/jobs",
"properties": {
"created": "2021-06-01T00:00:00Z",
"state": "Finished",
"input": {
"@odata.type": "#Microsoft.Media.JobInputs",
"inputs": [
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
"inputDefinitions": [],
"assetName": "job3-InputAsset"
}
]
},
"lastModified": "2021-06-01T00:00:00Z",
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
"state": "Finished",
"progress": 100,
"label": "example-custom-label",
"startTime": "2022-10-17T23:04:33.1104174Z",
"endTime": "2022-10-17T23:14:33.1104174Z",
"assetName": "job3-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
"startTime": "2022-10-17T23:04:33.1104174Z",
"endTime": "2022-10-17T23:14:33.1104174Z"
},
"systemData": {
"createdBy": "contoso@microsoft.com",
"createdByType": "User",
"createdAt": "2021-06-01T00:00:00Z",
"lastModifiedBy": "contoso@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-01T00:00:00Z"
}
}
]
}
Lists Jobs for the Transform filter by name.
| Technology | Sample request |
|---|---|
| HTTP |
GET https://{{api-endpoint}}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaServices/contosomedia/transforms/exampleTransform/jobs?api-version={{api-version}}&$filter=name eq 'job3' and properties/state eq Microsoft.Media.JobState'finished'
|
| Java |
/**
* Samples for Jobs List.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-
* filter-by-name-and-state.json
*/
/**
* Sample code: Lists Jobs for the Transform filter by name and state.
*
* @param manager Entry point to MediaServicesManager.
*/
public static void listsJobsForTheTransformFilterByNameAndState(
com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
manager.jobs().list("contosoresources", "contosomedia", "exampleTransform",
"name eq 'job3' and properties/state eq Microsoft.Media.JobState'finished'", null,
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| Python |
from azure.identity import DefaultAzureCredential
from azure.mgmt.media import AzureMediaServices
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-media
# USAGE
python jobslistallfilterbynameandstate.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = AzureMediaServices(
credential=DefaultAzureCredential(),
subscription_id="00000000-0000-0000-0000-000000000000",
)
response = client.jobs.list(
resource_group_name="contosoresources",
account_name="contosomedia",
transform_name="exampleTransform",
)
for item in response:
print(item)
# x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-name-and-state.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| Go |
package armmediaservices_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mediaservices/armmediaservices/v3"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e7bf3adfa2d5e5cdbb804eec35279501794f461c/specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-name-and-state.json
func ExampleJobsClient_NewListPager_listsJobsForTheTransformFilterByNameAndState() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmediaservices.NewClientFactory("", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewJobsClient().NewListPager("contosoresources", "contosomedia", "exampleTransform", &armmediaservices.JobsClientListOptions{Filter: to.Ptr("name eq 'job3' and properties/state eq Microsoft.Media.JobState'finished'"),
Orderby: nil,
})
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.JobCollection = armmediaservices.JobCollection{
// Value: []*armmediaservices.Job{
// {
// Name: to.Ptr("job3"),
// Type: to.Ptr("Microsoft.Media/mediaservices/transforms/jobs"),
// ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3"),
// Properties: &armmediaservices.JobProperties{
// CorrelationData: map[string]*string{
// },
// Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:14:33.110Z"); return t}()),
// Input: &armmediaservices.JobInputs{
// ODataType: to.Ptr("#Microsoft.Media.JobInputs"),
// Inputs: []armmediaservices.JobInputClassification{
// &armmediaservices.JobInputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobInputAsset"),
// Files: []*string{
// },
// InputDefinitions: []armmediaservices.InputDefinitionClassification{
// },
// AssetName: to.Ptr("job3-InputAsset"),
// }},
// },
// LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// Outputs: []armmediaservices.JobOutputClassification{
// &armmediaservices.JobOutputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobOutputAsset"),
// EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:14:33.110Z"); return t}()),
// Label: to.Ptr("example-custom-label"),
// Progress: to.Ptr[int32](100),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:33.110Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateFinished),
// AssetName: to.Ptr("job3-OutputAsset"),
// }},
// Priority: to.Ptr(armmediaservices.PriorityLow),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:33.110Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateFinished),
// },
// SystemData: &armmediaservices.SystemData{
// CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// CreatedBy: to.Ptr("contoso@microsoft.com"),
// CreatedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// LastModifiedBy: to.Ptr("contoso@microsoft.com"),
// LastModifiedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| JavaScript |
const { AzureMediaServices } = require("@azure/arm-mediaservices");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Lists all of the Jobs for the Transform.
*
* @summary Lists all of the Jobs for the Transform.
* x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-name-and-state.json
*/
async function listsJobsForTheTransformFilterByNameAndState() {
const subscriptionId =
process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contosoresources";
const accountName = "contosomedia";
const transformName = "exampleTransform";
const filter = "name eq 'job3' and properties/state eq Microsoft.Media.JobState'finished'";
const options = { filter };
const credential = new DefaultAzureCredential();
const client = new AzureMediaServices(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.jobs.list(resourceGroupName, accountName, transformName, options)) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| .NET |
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Media;
using Azure.ResourceManager.Media.Models;
// Generated from example definition: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-name-and-state.json
// this example is just showing the usage of "Jobs_List" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this MediaTransformResource created on azure
// for more information of creating MediaTransformResource, please refer to the document of MediaTransformResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "contosoresources";
string accountName = "contosomedia";
string transformName = "exampleTransform";
ResourceIdentifier mediaTransformResourceId = MediaTransformResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, transformName);
MediaTransformResource mediaTransform = client.GetMediaTransformResource(mediaTransformResourceId);
// get the collection of this MediaJobResource
MediaJobCollection collection = mediaTransform.GetMediaJobs();
// invoke the operation and iterate over the result
string filter = "name eq 'job3' and properties/state eq Microsoft.Media.JobState'finished'";
await foreach (MediaJobResource item in collection.GetAllAsync(filter: filter))
{
// the variable item is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
MediaJobData resourceData = item.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}
Console.WriteLine($"Succeeded");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
Sample response
Status code: 200
{
"value": [
{
"name": "job3",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3",
"type": "Microsoft.Media/mediaservices/transforms/jobs",
"properties": {
"created": "2021-06-01T00:00:00Z",
"state": "Finished",
"input": {
"@odata.type": "#Microsoft.Media.JobInputs",
"inputs": [
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
"inputDefinitions": [],
"assetName": "job3-InputAsset"
}
]
},
"lastModified": "2021-06-01T00:00:00Z",
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
"state": "Finished",
"progress": 100,
"label": "example-custom-label",
"startTime": "2022-10-17T23:04:33.1104174Z",
"endTime": "2022-10-17T23:14:33.1104174Z",
"assetName": "job3-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
"startTime": "2022-10-17T23:04:33.1104174Z",
"endTime": "2022-10-17T23:14:33.1104174Z"
},
"systemData": {
"createdBy": "contoso@microsoft.com",
"createdByType": "User",
"createdAt": "2021-06-01T00:00:00Z",
"lastModifiedBy": "contoso@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-01T00:00:00Z"
}
}
]
}
Lists Jobs for the Transform filter by state equal.
| Technology | Sample request |
|---|---|
| HTTP |
GET https://{{api-endpoint}}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaServices/contosomedia/transforms/exampleTransform/jobs?api-version={{api-version}}&$filter=properties/state eq Microsoft.Media.JobState'Processing'
|
| Java |
/**
* Samples for Jobs List.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-
* filter-by-state-eq.json
*/
/**
* Sample code: Lists Jobs for the Transform filter by state equal.
*
* @param manager Entry point to MediaServicesManager.
*/
public static void listsJobsForTheTransformFilterByStateEqual(
com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
manager.jobs().list("contosoresources", "contosomedia", "exampleTransform",
"properties/state eq Microsoft.Media.JobState'Processing'", null, com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| Python |
from azure.identity import DefaultAzureCredential
from azure.mgmt.media import AzureMediaServices
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-media
# USAGE
python jobslistallfilterbystateeq.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = AzureMediaServices(
credential=DefaultAzureCredential(),
subscription_id="00000000-0000-0000-0000-000000000000",
)
response = client.jobs.list(
resource_group_name="contosoresources",
account_name="contosomedia",
transform_name="exampleTransform",
)
for item in response:
print(item)
# x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-state-eq.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| Go |
package armmediaservices_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mediaservices/armmediaservices/v3"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e7bf3adfa2d5e5cdbb804eec35279501794f461c/specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-state-eq.json
func ExampleJobsClient_NewListPager_listsJobsForTheTransformFilterByStateEqual() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmediaservices.NewClientFactory("", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewJobsClient().NewListPager("contosoresources", "contosomedia", "exampleTransform", &armmediaservices.JobsClientListOptions{Filter: to.Ptr("properties/state eq Microsoft.Media.JobState'Processing'"),
Orderby: nil,
})
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.JobCollection = armmediaservices.JobCollection{
// Value: []*armmediaservices.Job{
// {
// Name: to.Ptr("job2"),
// Type: to.Ptr("Microsoft.Media/mediaservices/transforms/jobs"),
// ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2"),
// Properties: &armmediaservices.JobProperties{
// CorrelationData: map[string]*string{
// },
// Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// Input: &armmediaservices.JobInputs{
// ODataType: to.Ptr("#Microsoft.Media.JobInputs"),
// Inputs: []armmediaservices.JobInputClassification{
// &armmediaservices.JobInputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobInputAsset"),
// Files: []*string{
// },
// InputDefinitions: []armmediaservices.InputDefinitionClassification{
// },
// AssetName: to.Ptr("job2-InputAsset"),
// }},
// },
// LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// Outputs: []armmediaservices.JobOutputClassification{
// &armmediaservices.JobOutputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobOutputAsset"),
// Label: to.Ptr("example-custom-label"),
// Progress: to.Ptr[int32](50),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:32.828Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateProcessing),
// AssetName: to.Ptr("job2-OutputAsset"),
// }},
// Priority: to.Ptr(armmediaservices.PriorityLow),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:32.828Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateProcessing),
// },
// SystemData: &armmediaservices.SystemData{
// CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// CreatedBy: to.Ptr("contoso@microsoft.com"),
// CreatedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// LastModifiedBy: to.Ptr("contoso@microsoft.com"),
// LastModifiedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// },
// },
// {
// Name: to.Ptr("job3"),
// Type: to.Ptr("Microsoft.Media/mediaservices/transforms/jobs"),
// ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3"),
// Properties: &armmediaservices.JobProperties{
// CorrelationData: map[string]*string{
// },
// Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// Input: &armmediaservices.JobInputs{
// ODataType: to.Ptr("#Microsoft.Media.JobInputs"),
// Inputs: []armmediaservices.JobInputClassification{
// &armmediaservices.JobInputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobInputAsset"),
// Files: []*string{
// },
// InputDefinitions: []armmediaservices.InputDefinitionClassification{
// },
// AssetName: to.Ptr("job3-InputAsset"),
// }},
// },
// LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// Outputs: []armmediaservices.JobOutputClassification{
// &armmediaservices.JobOutputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobOutputAsset"),
// Label: to.Ptr("example-custom-label"),
// Progress: to.Ptr[int32](50),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:32.828Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateProcessing),
// AssetName: to.Ptr("job3-OutputAsset"),
// }},
// Priority: to.Ptr(armmediaservices.PriorityLow),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:32.828Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateProcessing),
// },
// SystemData: &armmediaservices.SystemData{
// CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// CreatedBy: to.Ptr("contoso@microsoft.com"),
// CreatedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// LastModifiedBy: to.Ptr("contoso@microsoft.com"),
// LastModifiedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| JavaScript |
const { AzureMediaServices } = require("@azure/arm-mediaservices");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Lists all of the Jobs for the Transform.
*
* @summary Lists all of the Jobs for the Transform.
* x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-state-eq.json
*/
async function listsJobsForTheTransformFilterByStateEqual() {
const subscriptionId =
process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contosoresources";
const accountName = "contosomedia";
const transformName = "exampleTransform";
const filter = "properties/state eq Microsoft.Media.JobState'Processing'";
const options = { filter };
const credential = new DefaultAzureCredential();
const client = new AzureMediaServices(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.jobs.list(resourceGroupName, accountName, transformName, options)) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| .NET |
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Media;
using Azure.ResourceManager.Media.Models;
// Generated from example definition: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-state-eq.json
// this example is just showing the usage of "Jobs_List" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this MediaTransformResource created on azure
// for more information of creating MediaTransformResource, please refer to the document of MediaTransformResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "contosoresources";
string accountName = "contosomedia";
string transformName = "exampleTransform";
ResourceIdentifier mediaTransformResourceId = MediaTransformResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, transformName);
MediaTransformResource mediaTransform = client.GetMediaTransformResource(mediaTransformResourceId);
// get the collection of this MediaJobResource
MediaJobCollection collection = mediaTransform.GetMediaJobs();
// invoke the operation and iterate over the result
string filter = "properties/state eq Microsoft.Media.JobState'Processing'";
await foreach (MediaJobResource item in collection.GetAllAsync(filter: filter))
{
// the variable item is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
MediaJobData resourceData = item.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}
Console.WriteLine($"Succeeded");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
Sample response
Status code: 200
{
"value": [
{
"name": "job2",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2",
"type": "Microsoft.Media/mediaservices/transforms/jobs",
"properties": {
"created": "2021-06-01T00:00:00Z",
"state": "Processing",
"input": {
"@odata.type": "#Microsoft.Media.JobInputs",
"inputs": [
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
"inputDefinitions": [],
"assetName": "job2-InputAsset"
}
]
},
"lastModified": "2021-06-01T00:00:00Z",
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
"state": "Processing",
"progress": 50,
"label": "example-custom-label",
"startTime": "2022-10-17T23:04:32.8284289Z",
"assetName": "job2-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
"startTime": "2022-10-17T23:04:32.8284289Z"
},
"systemData": {
"createdBy": "contoso@microsoft.com",
"createdByType": "User",
"createdAt": "2021-06-01T00:00:00Z",
"lastModifiedBy": "contoso@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-01T00:00:00Z"
}
},
{
"name": "job3",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3",
"type": "Microsoft.Media/mediaservices/transforms/jobs",
"properties": {
"created": "2021-06-01T00:00:00Z",
"state": "Processing",
"input": {
"@odata.type": "#Microsoft.Media.JobInputs",
"inputs": [
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
"inputDefinitions": [],
"assetName": "job3-InputAsset"
}
]
},
"lastModified": "2021-06-01T00:00:00Z",
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
"state": "Processing",
"progress": 50,
"label": "example-custom-label",
"startTime": "2022-10-17T23:04:32.8284289Z",
"assetName": "job3-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
"startTime": "2022-10-17T23:04:32.8284289Z"
},
"systemData": {
"createdBy": "contoso@microsoft.com",
"createdByType": "User",
"createdAt": "2021-06-01T00:00:00Z",
"lastModifiedBy": "contoso@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-01T00:00:00Z"
}
}
]
}
Lists Jobs for the Transform filter by state not equal.
| Technology | Sample request |
|---|---|
| HTTP |
GET https://{{api-endpoint}}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaServices/contosomedia/transforms/exampleTransform/jobs?api-version={{api-version}}&$filter=properties/state ne Microsoft.Media.JobState'processing'
|
| Java |
/**
* Samples for Jobs List.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-
* filter-by-state-ne.json
*/
/**
* Sample code: Lists Jobs for the Transform filter by state not equal.
*
* @param manager Entry point to MediaServicesManager.
*/
public static void listsJobsForTheTransformFilterByStateNotEqual(
com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
manager.jobs().list("contosoresources", "contosomedia", "exampleTransform",
"properties/state ne Microsoft.Media.JobState'processing'", null, com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| Python |
from azure.identity import DefaultAzureCredential
from azure.mgmt.media import AzureMediaServices
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-media
# USAGE
python jobslistallfilterbystatene.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = AzureMediaServices(
credential=DefaultAzureCredential(),
subscription_id="00000000-0000-0000-0000-000000000000",
)
response = client.jobs.list(
resource_group_name="contosoresources",
account_name="contosomedia",
transform_name="exampleTransform",
)
for item in response:
print(item)
# x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-state-ne.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| Go |
package armmediaservices_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mediaservices/armmediaservices/v3"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e7bf3adfa2d5e5cdbb804eec35279501794f461c/specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-state-ne.json
func ExampleJobsClient_NewListPager_listsJobsForTheTransformFilterByStateNotEqual() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armmediaservices.NewClientFactory("", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewJobsClient().NewListPager("contosoresources", "contosomedia", "exampleTransform", &armmediaservices.JobsClientListOptions{Filter: to.Ptr("properties/state ne Microsoft.Media.JobState'processing'"),
Orderby: nil,
})
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.JobCollection = armmediaservices.JobCollection{
// Value: []*armmediaservices.Job{
// {
// Name: to.Ptr("job1"),
// Type: to.Ptr("Microsoft.Media/mediaservices/transforms/jobs"),
// ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1"),
// Properties: &armmediaservices.JobProperties{
// CorrelationData: map[string]*string{
// },
// Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// Input: &armmediaservices.JobInputs{
// ODataType: to.Ptr("#Microsoft.Media.JobInputs"),
// Inputs: []armmediaservices.JobInputClassification{
// &armmediaservices.JobInputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobInputAsset"),
// Files: []*string{
// },
// InputDefinitions: []armmediaservices.InputDefinitionClassification{
// },
// AssetName: to.Ptr("job1-InputAsset"),
// }},
// },
// LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// Outputs: []armmediaservices.JobOutputClassification{
// &armmediaservices.JobOutputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobOutputAsset"),
// Label: to.Ptr("example-custom-label"),
// Progress: to.Ptr[int32](0),
// State: to.Ptr(armmediaservices.JobStateQueued),
// AssetName: to.Ptr("job1-OutputAsset"),
// }},
// Priority: to.Ptr(armmediaservices.PriorityLow),
// State: to.Ptr(armmediaservices.JobStateQueued),
// },
// SystemData: &armmediaservices.SystemData{
// CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// CreatedBy: to.Ptr("contoso@microsoft.com"),
// CreatedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// LastModifiedBy: to.Ptr("contoso@microsoft.com"),
// LastModifiedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// },
// },
// {
// Name: to.Ptr("job4"),
// Type: to.Ptr("Microsoft.Media/mediaservices/transforms/jobs"),
// ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job4"),
// Properties: &armmediaservices.JobProperties{
// CorrelationData: map[string]*string{
// },
// Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:14:33.009Z"); return t}()),
// Input: &armmediaservices.JobInputs{
// ODataType: to.Ptr("#Microsoft.Media.JobInputs"),
// Inputs: []armmediaservices.JobInputClassification{
// &armmediaservices.JobInputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobInputAsset"),
// Files: []*string{
// },
// InputDefinitions: []armmediaservices.InputDefinitionClassification{
// },
// AssetName: to.Ptr("job4-InputAsset"),
// }},
// },
// LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// Outputs: []armmediaservices.JobOutputClassification{
// &armmediaservices.JobOutputAsset{
// ODataType: to.Ptr("#Microsoft.Media.JobOutputAsset"),
// EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:14:33.009Z"); return t}()),
// Label: to.Ptr("example-custom-label"),
// Progress: to.Ptr[int32](100),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:33.009Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateFinished),
// AssetName: to.Ptr("job4-OutputAsset"),
// }},
// Priority: to.Ptr(armmediaservices.PriorityLow),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-10-17T23:04:33.009Z"); return t}()),
// State: to.Ptr(armmediaservices.JobStateFinished),
// },
// SystemData: &armmediaservices.SystemData{
// CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// CreatedBy: to.Ptr("contoso@microsoft.com"),
// CreatedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-01T00:00:00.000Z"); return t}()),
// LastModifiedBy: to.Ptr("contoso@microsoft.com"),
// LastModifiedByType: to.Ptr(armmediaservices.CreatedByTypeUser),
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| JavaScript |
const { AzureMediaServices } = require("@azure/arm-mediaservices");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Lists all of the Jobs for the Transform.
*
* @summary Lists all of the Jobs for the Transform.
* x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-state-ne.json
*/
async function listsJobsForTheTransformFilterByStateNotEqual() {
const subscriptionId =
process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contosoresources";
const accountName = "contosomedia";
const transformName = "exampleTransform";
const filter = "properties/state ne Microsoft.Media.JobState'processing'";
const options = { filter };
const credential = new DefaultAzureCredential();
const client = new AzureMediaServices(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.jobs.list(resourceGroupName, accountName, transformName, options)) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
| .NET |
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Media;
using Azure.ResourceManager.Media.Models;
// Generated from example definition: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/jobs-list-all-filter-by-state-ne.json
// this example is just showing the usage of "Jobs_List" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this MediaTransformResource created on azure
// for more information of creating MediaTransformResource, please refer to the document of MediaTransformResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "contosoresources";
string accountName = "contosomedia";
string transformName = "exampleTransform";
ResourceIdentifier mediaTransformResourceId = MediaTransformResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, transformName);
MediaTransformResource mediaTransform = client.GetMediaTransformResource(mediaTransformResourceId);
// get the collection of this MediaJobResource
MediaJobCollection collection = mediaTransform.GetMediaJobs();
// invoke the operation and iterate over the result
string filter = "properties/state ne Microsoft.Media.JobState'processing'";
await foreach (MediaJobResource item in collection.GetAllAsync(filter: filter))
{
// the variable item is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
MediaJobData resourceData = item.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}
Console.WriteLine($"Succeeded");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue. |
Sample response
Status code: 200
{
"value": [
{
"name": "job1",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1",
"type": "Microsoft.Media/mediaservices/transforms/jobs",
"properties": {
"created": "2021-06-01T00:00:00Z",
"state": "Queued",
"input": {
"@odata.type": "#Microsoft.Media.JobInputs",
"inputs": [
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
"inputDefinitions": [],
"assetName": "job1-InputAsset"
}
]
},
"lastModified": "2021-06-01T00:00:00Z",
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
"state": "Queued",
"progress": 0,
"label": "example-custom-label",
"assetName": "job1-OutputAsset"
}
],
"priority": "Low",
"correlationData": {}
},
"systemData": {
"createdBy": "contoso@microsoft.com",
"createdByType": "User",
"createdAt": "2021-06-01T00:00:00Z",
"lastModifiedBy": "contoso@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-01T00:00:00Z"
}
},
{
"name": "job4",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job4",
"type": "Microsoft.Media/mediaservices/transforms/jobs",
"properties": {
"created": "2021-06-01T00:00:00Z",
"state": "Finished",
"input": {
"@odata.type": "#Microsoft.Media.JobInputs",
"inputs": [
{
"@odata.type": "#Microsoft.Media.JobInputAsset",
"files": [],
"inputDefinitions": [],
"assetName": "job4-InputAsset"
}
]
},
"lastModified": "2021-06-01T00:00:00Z",
"outputs": [
{
"@odata.type": "#Microsoft.Media.JobOutputAsset",
"state": "Finished",
"progress": 100,
"label": "example-custom-label",
"startTime": "2022-10-17T23:04:33.0097637Z",
"endTime": "2022-10-17T23:14:33.0097637Z",
"assetName": "job4-OutputAsset"
}
],
"priority": "Low",
"correlationData": {},
"startTime": "2022-10-17T23:04:33.0097637Z",
"endTime": "2022-10-17T23:14:33.0097637Z"
},
"systemData": {
"createdBy": "contoso@microsoft.com",
"createdByType": "User",
"createdAt": "2021-06-01T00:00:00Z",
"lastModifiedBy": "contoso@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-01T00:00:00Z"
}
}
]
}
Definitions
| Name | Description |
|---|---|
| AacAudio | Describes Advanced Audio Codec (AAC) audio encoding settings. |
| AacAudioProfile | The encoding profile to be used when encoding audio with AAC. |
| AbsoluteClipTime | Specifies the clip time as an absolute time position in the media file. The absolute time can point to a different position depending on whether the media file starts from a timestamp of zero or not. |
| AttributeFilter | The type of AttributeFilter to apply to the TrackAttribute in order to select the tracks. |
| Audio | Defines the common properties for all audio codecs. |
| AudioAnalysisMode | Determines the set of audio analysis operations to be performed. If unspecified, the Standard AudioAnalysisMode would be chosen. |
| AudioAnalyzerPreset | The Audio Analyzer preset applies a pre-defined set of AI-based analysis operations, including speech transcription. Currently, the preset supports processing of content with a single audio track. |
| AudioTrackDescriptor | A TrackSelection to select audio tracks. |
| BlurType | Blur type |
| BuiltInStandardEncoderPreset | Describes a built-in preset for encoding the input video with the Standard Encoder. |
| Complexity | Allows you to configure the encoder settings to control the balance between speed and quality. Example: set Complexity as Speed for faster encoding but less compression efficiency. |
| CopyAudio | A codec flag, which tells the encoder to copy the input audio bitstream. |
| CopyVideo | A codec flag, which tells the encoder to copy the input video bitstream without re-encoding. |
| createdByType | The type of identity that created the resource. |
| DDAudio | Describes Dolby Digital Audio Codec (AC3) audio encoding settings. The current implementation for Dolby Digital Audio support are: Audio channel numbers at 1((mono), 2(stereo), 6(5.1side); Audio sampling frequency rates at: 32K/44.1K/48K Hz; Audio bitrate values as AC3 specification supports: 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, 224000, 256000, 320000, 384000, 448000, 512000, 576000, 640000 bps. |
| Deinterlace | Describes the de-interlacing settings. |
| DeinterlaceMode | The deinterlacing mode. Defaults to AutoPixelAdaptive. |
| DeinterlaceParity | The field parity for de-interlacing, defaults to Auto. |
| EncoderNamedPreset | The built-in preset to be used for encoding videos. |
| EntropyMode | The entropy mode to be used for this layer. If not specified, the encoder chooses the mode that is appropriate for the profile and level. |
| ErrorAdditionalInfo | The resource management error additional info. |
| ErrorDetail | The error detail. |
| ErrorResponse | Error response |
| Fade | Describes the properties of a Fade effect applied to the input media. |
| Filters | Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding. |
| FromAllInputFile | An InputDefinition that looks across all of the files provided to select tracks specified by the IncludedTracks property. Generally used with the AudioTrackByAttribute and VideoTrackByAttribute to allow selection of a single track across a set of input files. |
| FromEachInputFile | An InputDefinition that looks at each input file provided to select tracks specified by the IncludedTracks property. Generally used with the AudioTrackByAttribute and VideoTrackByAttribute to select tracks from each file given. |
| H264Complexity | Tells the encoder how to choose its encoding settings. The default value is Balanced. |
| H264Layer | Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.264 video codec. |
| H264RateControlMode | The video rate control mode |
| H264Video | Describes all the properties for encoding a video with the H.264 codec. |
| H264VideoProfile | We currently support Baseline, Main, High, High422, High444. Default is Auto. |
| H265Complexity | Tells the encoder how to choose its encoding settings. Quality will provide for a higher compression ratio but at a higher cost and longer compute time. Speed will produce a relatively larger file but is faster and more economical. The default value is Balanced. |
| H265Layer | Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.265 video codec. |
| H265Video | Describes all the properties for encoding a video with the H.265 codec. |
| H265VideoProfile | We currently support Main. Default is Auto. |
| Image | Describes the basic properties for generating thumbnails from the input video |
| ImageFormat | Describes the properties for an output image file. |
| InputFile | An InputDefinition for a single file. TrackSelections are scoped to the file specified. |
| InterleaveOutput |
Sets the interleave mode of the output to control how audio and video are stored in the container format. Example: set InterleavedOutput as NonInterleavedOutput to produce audio-only and video-only outputs in separate MP4 files. RMS does not support this definition parameter. |
| Job | A Job resource type. The progress and state can be obtained by polling a Job or subscribing to events using EventGrid. |
| JobCollection | A collection of Job items. |
| JobError | Details of JobOutput errors. |
| JobErrorCategory | Helps with categorization of errors. |
| JobErrorCode | Error code describing the error. |
| JobErrorDetail | Details of JobOutput errors. |
| JobInputAsset | Represents an Asset for input into a Job. |
| JobInputClip | Represents input files for a Job. |
| JobInputHttp | Represents HTTPS job input. |
| JobInputs | Describes a list of inputs to a Job. |
| JobInputSequence | A Sequence contains an ordered list of Clips where each clip is a JobInput. The Sequence will be treated as a single input. |
| JobOutputAsset | Represents an Asset used as a JobOutput. |
| JobRetry | Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. |
| JobState | Describes the state of the JobOutput. |
| JpgFormat | Describes the settings for producing JPEG thumbnails. |
| JpgImage | Describes the properties for producing a series of JPEG images from the input video. |
| JpgLayer | Describes the settings to produce a JPEG image from the input video. |
| Mp4Format | Describes the properties for an output ISO MP4 file. |
| MultiBitrateFormat | Describes the properties for producing a collection of GOP aligned multi-bitrate files. The default behavior is to produce one output file for each video layer which is muxed together with all the audios. The exact output files produced can be controlled by specifying the outputFiles collection. |
| OutputFile | Represents an output file produced. |
| PngFormat | Describes the settings for producing PNG thumbnails. |
| PngImage | Describes the properties for producing a series of PNG images from the input video. |
| PngLayer | Describes the settings to produce a PNG image from the input video. |
| PresetConfigurations | An object of optional configuration settings for encoder. |
| Priority | Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal. |
| Rectangle | Describes the properties of a rectangular window applied to the input media before processing it. |
| Rotation | The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto |
| SelectAudioTrackByAttribute | Select audio tracks from the input by specifying an attribute and an attribute filter. |
| SelectAudioTrackById | Select audio tracks from the input by specifying a track identifier. |
| SelectVideoTrackByAttribute | Select video tracks from the input by specifying an attribute and an attribute filter. |
| SelectVideoTrackById | Select video tracks from the input by specifying a track identifier. |
| StandardEncoderPreset | Describes all the settings to be used when encoding the input video with the Standard Encoder. |
| StretchMode | The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize |
| systemData | Metadata pertaining to creation and last modification of the resource. |
| TrackAttribute | The TrackAttribute to filter the tracks by. |
| UtcClipTime | Specifies the clip time as a Utc time position in the media file. The Utc time can point to a different position depending on whether the media file starts from a timestamp of zero or not. |
| Video | Describes the basic properties for encoding the input video. |
| VideoOverlay | Describes the properties of a video overlay. |
| VideoSyncMode | The Video Sync Mode |
| VideoTrackDescriptor | A TrackSelection to select video tracks. |
AacAudio
Describes Advanced Audio Codec (AAC) audio encoding settings.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.AacAudio |
The discriminator for derived types. |
| bitrate | integer | The bitrate, in bits per second, of the output encoded audio. |
| channels | integer | The number of channels in the audio. |
| label | string | An optional label for the codec. The label can be used to control muxing behavior. |
| profile | AacAudioProfile | The encoding profile to be used when encoding audio with AAC. |
| samplingRate | integer | The sampling rate to use for encoding in hertz. |
AacAudioProfile
The encoding profile to be used when encoding audio with AAC.
| Name | Type | Description |
|---|---|---|
| AacLc | string | Specifies that the output audio is to be encoded into AAC Low Complexity profile (AAC-LC). |
| HeAacV1 | string | Specifies that the output audio is to be encoded into HE-AAC v1 profile. |
| HeAacV2 | string | Specifies that the output audio is to be encoded into HE-AAC v2 profile. |
AbsoluteClipTime
Specifies the clip time as an absolute time position in the media file. The absolute time can point to a different position depending on whether the media file starts from a timestamp of zero or not.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.AbsoluteClipTime |
The discriminator for derived types. |
| time | string | The time position on the timeline of the input media. It is usually specified as an ISO8601 period. e.g PT30S for 30 seconds. |
AttributeFilter
The type of AttributeFilter to apply to the TrackAttribute in order to select the tracks.
| Name | Type | Description |
|---|---|---|
| All | string | All tracks will be included. |
| Bottom | string | The first track will be included when the attribute is sorted in ascending order. Generally used to select the smallest bitrate. |
| Top | string | The first track will be included when the attribute is sorted in descending order. Generally used to select the largest bitrate. |
| ValueEquals | string | Any tracks that have an attribute equal to the value given will be included. |
Audio
Defines the common properties for all audio codecs.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.Audio |
The discriminator for derived types. |
| bitrate | integer | The bitrate, in bits per second, of the output encoded audio. |
| channels | integer | The number of channels in the audio. |
| label | string | An optional label for the codec. The label can be used to control muxing behavior. |
| samplingRate | integer | The sampling rate to use for encoding in hertz. |
AudioAnalysisMode
Determines the set of audio analysis operations to be performed. If unspecified, the Standard AudioAnalysisMode would be chosen.
| Name | Type | Description |
|---|---|---|
| Basic | string | This mode performs speech-to-text transcription and generation of a VTT subtitle/caption file. The output of this mode includes an Insights JSON file including only the keywords, transcription,and timing information. Automatic language detection and speaker diarization are not included in this mode. |
| Standard | string | Performs all operations included in the Basic mode, additionally performing language detection and speaker diarization. |
AudioAnalyzerPreset
The Audio Analyzer preset applies a pre-defined set of AI-based analysis operations, including speech transcription. Currently, the preset supports processing of content with a single audio track.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media. AudioAnalyzerPreset |
The discriminator for derived types. |
| audioLanguage | string | The language for the audio payload in the input using the BCP-47 format of 'language tag-region' (e.g: 'en-US'). If you know the language of your content, it is recommended that you specify it. The language must be specified explicitly for AudioAnalysisMode::Basic, since automatic language detection is not included in basic mode. If the language isn't specified or set to null, automatic language detection will choose the first language detected and process with the selected language for the duration of the file. It does not currently support dynamically switching between languages after the first language is detected. The automatic detection works best with audio recordings with clearly discernable speech. If automatic detection fails to find the language, transcription would fallback to 'en-US'." The list of supported languages is available here: https://go.microsoft.com/fwlink/?linkid=2109463 |
| experimentalOptions | object | Dictionary containing key value pairs for parameters not exposed in the preset itself |
| mode | AudioAnalysisMode | Determines the set of audio analysis operations to be performed. If unspecified, the Standard AudioAnalysisMode would be chosen. |
AudioTrackDescriptor
A TrackSelection to select audio tracks.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.AudioTrackDescriptor |
The discriminator for derived types. |
BlurType
| Name | Type | Description |
|---|---|---|
| Black | string | Black: Black out filter |
| Box | string | Box: debug filter, bounding box only |
| High | string | High: Confuse blur filter |
| Low | string | Low: box-car blur filter |
| Med | string | Med: Gaussian blur filter |
BuiltInStandardEncoderPreset
Describes a built-in preset for encoding the input video with the Standard Encoder.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.BuiltIn StandardEncoderPreset |
The discriminator for derived types. |
| configurations | PresetConfigurations | Optional configuration settings for encoder. Configurations is only supported for ContentAwareEncoding and H265ContentAwareEncoding BuiltInStandardEncoderPreset. |
| presetName | EncoderNamedPreset | The built-in preset to be used for encoding videos. |
Complexity
Allows you to configure the encoder settings to control the balance between speed and quality. Example: set Complexity as Speed for faster encoding but less compression efficiency.
| Name | Type | Description |
|---|---|---|
| Balanced | string | Configures the encoder to use settings that achieve a balance between speed and quality. |
| Quality | string | Configures the encoder to use settings optimized to produce higher quality output at the expense of slower overall encode time. |
| Speed | string | Configures the encoder to use settings optimized for faster encoding. Quality is sacrificed to decrease encoding time. |
CopyAudio
A codec flag, which tells the encoder to copy the input audio bitstream.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.CopyAudio |
The discriminator for derived types. |
| label | string | An optional label for the codec. The label can be used to control muxing behavior. |
CopyVideo
A codec flag, which tells the encoder to copy the input video bitstream without re-encoding.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.CopyVideo |
The discriminator for derived types. |
| label | string | An optional label for the codec. The label can be used to control muxing behavior. |
createdByType
The type of identity that created the resource.
| Name | Type |
|---|---|
| Application | string |
| Key | string |
| ManagedIdentity | string |
| User | string |
DDAudio
Describes Dolby Digital Audio Codec (AC3) audio encoding settings. The current implementation for Dolby Digital Audio support are: Audio channel numbers at 1((mono), 2(stereo), 6(5.1side); Audio sampling frequency rates at: 32K/44.1K/48K Hz; Audio bitrate values as AC3 specification supports: 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, 224000, 256000, 320000, 384000, 448000, 512000, 576000, 640000 bps.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.DDAudio |
The discriminator for derived types. |
| bitrate | integer | The bitrate, in bits per second, of the output encoded audio. |
| channels | integer | The number of channels in the audio. |
| label | string | An optional label for the codec. The label can be used to control muxing behavior. |
| samplingRate | integer | The sampling rate to use for encoding in hertz. |
Deinterlace
Describes the de-interlacing settings.
| Name | Type | Description |
|---|---|---|
| mode | DeinterlaceMode | The deinterlacing mode. Defaults to AutoPixelAdaptive. |
| parity | DeinterlaceParity | The field parity for de-interlacing, defaults to Auto. |
DeinterlaceMode
The deinterlacing mode. Defaults to AutoPixelAdaptive.
| Name | Type | Description |
|---|---|---|
| AutoPixelAdaptive | string | Apply automatic pixel adaptive de-interlacing on each frame in the input video. |
| Off | string | Disables de-interlacing of the source video. |
DeinterlaceParity
The field parity for de-interlacing, defaults to Auto.
| Name | Type | Description |
|---|---|---|
| Auto | string | Automatically detect the order of fields |
| BottomFieldFirst | string | Apply bottom field first processing of input video. |
| TopFieldFirst | string | Apply top field first processing of input video. |
EncoderNamedPreset
The built-in preset to be used for encoding videos.
| Name | Type | Description |
|---|---|---|
| AACGoodQualityAudio | string | Produces a single MP4 file containing only AAC stereo audio encoded at 192 kbps. |
| AdaptiveStreaming | string | Produces a set of GOP aligned MP4 files with H.264 video and stereo AAC audio. Auto-generates a bitrate ladder based on the input resolution, bitrate and frame rate. The auto-generated preset will never exceed the input resolution. For example, if the input is 720p, output will remain 720p at best. |
| ContentAwareEncoding | string | Produces a set of GOP-aligned MP4s by using content-aware encoding. Given any input content, the service performs an initial lightweight analysis of the input content, and uses the results to determine the optimal number of layers, appropriate bitrate and resolution settings for delivery by adaptive streaming. This preset is particularly effective for low and medium complexity videos, where the output files will be at lower bitrates but at a quality that still delivers a good experience to viewers. The output will contain MP4 files with video and audio interleaved. |
| H264MultipleBitrate1080p | string | Produces a set of 8 GOP-aligned MP4 files, ranging from 6000 kbps to 400 kbps, and stereo AAC audio. Resolution starts at 1080p and goes down to 180p. |
| H264MultipleBitrate720p | string | Produces a set of 6 GOP-aligned MP4 files, ranging from 3400 kbps to 400 kbps, and stereo AAC audio. Resolution starts at 720p and goes down to 180p. |
| H264MultipleBitrateSD | string | Produces a set of 5 GOP-aligned MP4 files, ranging from 1900kbps to 400 kbps, and stereo AAC audio. Resolution starts at 480p and goes down to 240p. |
| H264SingleBitrate1080p | string | Produces an MP4 file where the video is encoded with H.264 codec at 6750 kbps and a picture height of 1080 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps. |
| H264SingleBitrate720p | string | Produces an MP4 file where the video is encoded with H.264 codec at 4500 kbps and a picture height of 720 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps. |
| H264SingleBitrateSD | string | Produces an MP4 file where the video is encoded with H.264 codec at 2200 kbps and a picture height of 480 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps. |
| H265AdaptiveStreaming | string | Produces a set of GOP aligned MP4 files with H.265 video and stereo AAC audio. Auto-generates a bitrate ladder based on the input resolution, bitrate and frame rate. The auto-generated preset will never exceed the input resolution. For example, if the input is 720p, output will remain 720p at best. |
| H265ContentAwareEncoding | string | Produces a set of GOP-aligned MP4s by using content-aware encoding. Given any input content, the service performs an initial lightweight analysis of the input content, and uses the results to determine the optimal number of layers, appropriate bitrate and resolution settings for delivery by adaptive streaming. This preset is particularly effective for low and medium complexity videos, where the output files will be at lower bitrates but at a quality that still delivers a good experience to viewers. The output will contain MP4 files with video and audio interleaved. |
| H265SingleBitrate1080p | string | Produces an MP4 file where the video is encoded with H.265 codec at 3500 kbps and a picture height of 1080 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps. |
| H265SingleBitrate4K | string | Produces an MP4 file where the video is encoded with H.265 codec at 9500 kbps and a picture height of 2160 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps. |
| H265SingleBitrate720p | string | Produces an MP4 file where the video is encoded with H.265 codec at 1800 kbps and a picture height of 720 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps. |
EntropyMode
The entropy mode to be used for this layer. If not specified, the encoder chooses the mode that is appropriate for the profile and level.
| Name | Type | Description |
|---|---|---|
| Cabac | string | Context Adaptive Binary Arithmetic Coder (CABAC) entropy encoding. |
| Cavlc | string | Context Adaptive Variable Length Coder (CAVLC) entropy encoding. |
ErrorAdditionalInfo
The resource management error additional info.
| Name | Type | Description |
|---|---|---|
| info | object | The additional info. |
| type | string | The additional info type. |
ErrorDetail
The error detail.
| Name | Type | Description |
|---|---|---|
| additionalInfo | ErrorAdditionalInfo | The error additional info. |
| code | string | The error code. |
| details | ErrorDetail | The error details. |
| message | string | The error message. |
| target | string | The error target. |
ErrorResponse
Error response
| Name | Type | Description |
|---|---|---|
| error | ErrorDetail | The error object. |
Fade
Describes the properties of a Fade effect applied to the input media.
| Name | Type | Description |
|---|---|---|
| duration | string | The Duration of the fade effect in the video. The value can be in ISO 8601 format (For example, PT05S to fade In/Out a color during 5 seconds), or a frame count (For example, 10 to fade 10 frames from the start time), or a relative value to stream duration (For example, 10% to fade 10% of stream duration) |
| fadeColor | string | The Color for the fade In/Out. it can be on the CSS Level1 colors https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/color_keywords or an RGB/hex value: e.g: rgb(255,0,0), 0xFF0000 or #FF0000 |
| start | string | The position in the input video from where to start fade. The value can be in ISO 8601 format (For example, PT05S to start at 5 seconds), or a frame count (For example, 10 to start at the 10th frame), or a relative value to stream duration (For example, 10% to start at 10% of stream duration). Default is 0 |
Filters
Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding.
| Name | Type | Description |
|---|---|---|
| crop | Rectangle | The parameters for the rectangular window with which to crop the input video. |
| deinterlace | Deinterlace | The de-interlacing settings. |
| fadeIn | Fade | Describes the properties of a Fade effect applied to the input media. |
| fadeOut | Fade | Describes the properties of a Fade effect applied to the input media. |
| overlays | Overlay: |
The properties of overlays to be applied to the input video. These could be image or video overlays. |
| rotation | Rotation | The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto |
FromAllInputFile
An InputDefinition that looks across all of the files provided to select tracks specified by the IncludedTracks property. Generally used with the AudioTrackByAttribute and VideoTrackByAttribute to allow selection of a single track across a set of input files.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.FromAllInputFile |
The discriminator for derived types. |
| includedTracks | TrackDescriptor : |
The list of TrackDescriptors which define the metadata and selection of tracks in the input. |
FromEachInputFile
An InputDefinition that looks at each input file provided to select tracks specified by the IncludedTracks property. Generally used with the AudioTrackByAttribute and VideoTrackByAttribute to select tracks from each file given.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.FromEachInputFile |
The discriminator for derived types. |
| includedTracks | TrackDescriptor : |
The list of TrackDescriptors which define the metadata and selection of tracks in the input. |
H264Complexity
Tells the encoder how to choose its encoding settings. The default value is Balanced.
| Name | Type | Description |
|---|---|---|
| Balanced | string | Tells the encoder to use settings that achieve a balance between speed and quality. |
| Quality | string | Tells the encoder to use settings that are optimized to produce higher quality output at the expense of slower overall encode time. |
| Speed | string | Tells the encoder to use settings that are optimized for faster encoding. Quality is sacrificed to decrease encoding time. |
H264Layer
Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.264 video codec.
| Name | Type | Description |
|---|---|---|
| adaptiveBFrame | boolean | Whether or not adaptive B-frames are to be used when encoding this layer. If not specified, the encoder will turn it on whenever the video profile permits its use. |
| bFrames | integer | The number of B-frames to be used when encoding this layer. If not specified, the encoder chooses an appropriate number based on the video profile and level. |
| bitrate | integer | The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field. |
| bufferWindow | string | The VBV buffer window length. The value should be in ISO 8601 format. The value should be in the range [0.1-100] seconds. The default is 5 seconds (for example, PT5S). |
| crf | number | The value of CRF to be used when encoding this layer. This setting takes effect when RateControlMode of video codec is set at CRF mode. The range of CRF value is between 0 and 51, where lower values would result in better quality, at the expense of higher file sizes. Higher values mean more compression, but at some point quality degradation will be noticed. Default value is 23. |
| entropyMode | EntropyMode | The entropy mode to be used for this layer. If not specified, the encoder chooses the mode that is appropriate for the profile and level. |
| frameRate | string | The frame rate (in frames per second) at which to encode this layer. The value can be in the form of M/N where M and N are integers (For example, 30000/1001), or in the form of a number (For example, 30, or 29.97). The encoder enforces constraints on allowed frame rates based on the profile and level. If it is not specified, the encoder will use the same frame rate as the input video. |
| height | string | The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input. |
| label | string | The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. |
| level | string | We currently support Level up to 6.2. The value can be Auto, or a number that matches the H.264 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer. |
| maxBitrate | integer | The maximum bitrate (in bits per second), at which the VBV buffer should be assumed to refill. If not specified, defaults to the same value as bitrate. |
| profile | H264VideoProfile | We currently support Baseline, Main, High, High422, High444. Default is Auto. |
| referenceFrames | integer | The number of reference frames to be used when encoding this layer. If not specified, the encoder determines an appropriate number based on the encoder complexity setting. |
| slices | integer | The number of slices to be used when encoding this layer. If not specified, default is zero, which means that encoder will use a single slice for each frame. |
| width | string | The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input. |
H264RateControlMode
The video rate control mode
| Name | Type | Description |
|---|---|---|
| ABR | string | Average Bitrate (ABR) mode that hits the target bitrate: Default mode. |
| CBR | string | Constant Bitrate (CBR) mode that tightens bitrate variations around target bitrate. |
| CRF | string | Constant Rate Factor (CRF) mode that targets at constant subjective quality. |
H264Video
Describes all the properties for encoding a video with the H.264 codec.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.H264Video |
The discriminator for derived types. |
| complexity | H264Complexity | Tells the encoder how to choose its encoding settings. The default value is Balanced. |
| keyFrameInterval | string | The distance between two key frames. The value should be non-zero in the range [0.5, 20] seconds, specified in ISO 8601 format. The default is 2 seconds(PT2S). Note that this setting is ignored if VideoSyncMode.Passthrough is set, where the KeyFrameInterval value will follow the input source setting. |
| label | string | An optional label for the codec. The label can be used to control muxing behavior. |
| layers | H264Layer | The collection of output H.264 layers to be produced by the encoder. |
| rateControlMode | H264RateControlMode | The video rate control mode |
| sceneChangeDetection | boolean | Whether or not the encoder should insert key frames at scene changes. If not specified, the default is false. This flag should be set to true only when the encoder is being configured to produce a single output video. |
| stretchMode | StretchMode | The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize |
| syncMode | VideoSyncMode | The Video Sync Mode |
H264VideoProfile
We currently support Baseline, Main, High, High422, High444. Default is Auto.
| Name | Type | Description |
|---|---|---|
| Auto | string | Tells the encoder to automatically determine the appropriate H.264 profile. |
| Baseline | string | Baseline profile |
| High | string | High profile. |
| High422 | string | High 4:2:2 profile. |
| High444 | string | High 4:4:4 predictive profile. |
| Main | string | Main profile |
H265Complexity
Tells the encoder how to choose its encoding settings. Quality will provide for a higher compression ratio but at a higher cost and longer compute time. Speed will produce a relatively larger file but is faster and more economical. The default value is Balanced.
| Name | Type | Description |
|---|---|---|
| Balanced | string | Tells the encoder to use settings that achieve a balance between speed and quality. |
| Quality | string | Tells the encoder to use settings that are optimized to produce higher quality output at the expense of slower overall encode time. |
| Speed | string | Tells the encoder to use settings that are optimized for faster encoding. Quality is sacrificed to decrease encoding time. |
H265Layer
Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.265 video codec.
| Name | Type | Description |
|---|---|---|
| adaptiveBFrame | boolean | Specifies whether or not adaptive B-frames are to be used when encoding this layer. If not specified, the encoder will turn it on whenever the video profile permits its use. |
| bFrames | integer | The number of B-frames to be used when encoding this layer. If not specified, the encoder chooses an appropriate number based on the video profile and level. |
| bitrate | integer | The average bitrate in bits per second at which to encode the input video when generating this layer. For example: a target bitrate of 3000Kbps or 3Mbps means this value should be 3000000 This is a required field. |
| bufferWindow | string | The VBV buffer window length. The value should be in ISO 8601 format. The value should be in the range [0.1-100] seconds. The default is 5 seconds (for example, PT5S). |
| crf | number | The value of CRF to be used when encoding this layer. This setting takes effect when RateControlMode of video codec is set at CRF mode. The range of CRF value is between 0 and 51, where lower values would result in better quality, at the expense of higher file sizes. Higher values mean more compression, but at some point quality degradation will be noticed. Default value is 28. |
| frameRate | string | The frame rate (in frames per second) at which to encode this layer. The value can be in the form of M/N where M and N are integers (For example, 30000/1001), or in the form of a number (For example, 30, or 29.97). The encoder enforces constraints on allowed frame rates based on the profile and level. If it is not specified, the encoder will use the same frame rate as the input video. |
| height | string | The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input. |
| label | string | The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. |
| level | string | We currently support Level up to 6.2. The value can be Auto, or a number that matches the H.265 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer. |
| maxBitrate | integer | The maximum bitrate (in bits per second), at which the VBV buffer should be assumed to refill. If not specified, defaults to the same value as bitrate. |
| profile | H265VideoProfile | We currently support Main. Default is Auto. |
| referenceFrames | integer | The number of reference frames to be used when encoding this layer. If not specified, the encoder determines an appropriate number based on the encoder complexity setting. |
| slices | integer | The number of slices to be used when encoding this layer. If not specified, default is zero, which means that encoder will use a single slice for each frame. |
| width | string | The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input. |
H265Video
Describes all the properties for encoding a video with the H.265 codec.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media. H265Video |
The discriminator for derived types. |
| complexity | H265Complexity | Tells the encoder how to choose its encoding settings. Quality will provide for a higher compression ratio but at a higher cost and longer compute time. Speed will produce a relatively larger file but is faster and more economical. The default value is Balanced. |
| keyFrameInterval | string | The distance between two key frames. The value should be non-zero in the range [0.5, 20] seconds, specified in ISO 8601 format. The default is 2 seconds(PT2S). Note that this setting is ignored if VideoSyncMode.Passthrough is set, where the KeyFrameInterval value will follow the input source setting. |
| label | string | An optional label for the codec. The label can be used to control muxing behavior. |
| layers | H265Layer | The collection of output H.265 layers to be produced by the encoder. |
| sceneChangeDetection | boolean | Specifies whether or not the encoder should insert key frames at scene changes. If not specified, the default is false. This flag should be set to true only when the encoder is being configured to produce a single output video. |
| stretchMode | StretchMode | The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize |
| syncMode | VideoSyncMode | The Video Sync Mode |
H265VideoProfile
We currently support Main. Default is Auto.
| Name | Type | Description |
|---|---|---|
| Auto | string | Tells the encoder to automatically determine the appropriate H.265 profile. |
| Main | string | Main profile (https://x265.readthedocs.io/en/default/cli.html?highlight=profile#profile-level-tier) |
| Main10 | string | Main 10 profile (https://en.wikipedia.org/wiki/High_Efficiency_Video_Coding#Main_10 ) |
Image
Describes the basic properties for generating thumbnails from the input video
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.Image |
The discriminator for derived types. |
| keyFrameInterval | string | The distance between two key frames. The value should be non-zero in the range [0.5, 20] seconds, specified in ISO 8601 format. The default is 2 seconds(PT2S). Note that this setting is ignored if VideoSyncMode.Passthrough is set, where the KeyFrameInterval value will follow the input source setting. |
| label | string | An optional label for the codec. The label can be used to control muxing behavior. |
| range | string | The position relative to transform preset start time in the input video at which to stop generating thumbnails. The value can be in ISO 8601 format (For example, PT5M30S to stop at 5 minutes and 30 seconds from start time), or a frame count (For example, 300 to stop at the 300th frame from the frame at start time. If this value is 1, it means only producing one thumbnail at start time), or a relative value to the stream duration (For example, 50% to stop at half of stream duration from start time). The default value is 100%, which means to stop at the end of the stream. |
| start | string | The position in the input video from where to start generating thumbnails. The value can be in ISO 8601 format (For example, PT05S to start at 5 seconds), or a frame count (For example, 10 to start at the 10th frame), or a relative value to stream duration (For example, 10% to start at 10% of stream duration). Also supports a macro {Best}, which tells the encoder to select the best thumbnail from the first few seconds of the video and will only produce one thumbnail, no matter what other settings are for Step and Range. The default value is macro {Best}. |
| step | string | The intervals at which thumbnails are generated. The value can be in ISO 8601 format (For example, PT05S for one image every 5 seconds), or a frame count (For example, 30 for one image every 30 frames), or a relative value to stream duration (For example, 10% for one image every 10% of stream duration). Note: Step value will affect the first generated thumbnail, which may not be exactly the one specified at transform preset start time. This is due to the encoder, which tries to select the best thumbnail between start time and Step position from start time as the first output. As the default value is 10%, it means if stream has long duration, the first generated thumbnail might be far away from the one specified at start time. Try to select reasonable value for Step if the first thumbnail is expected close to start time, or set Range value at 1 if only one thumbnail is needed at start time. |
| stretchMode | StretchMode | The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize |
| syncMode | VideoSyncMode | The Video Sync Mode |
ImageFormat
Describes the properties for an output image file.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.ImageFormat |
The discriminator for derived types. |
| filenamePattern | string |
The file naming pattern used for the creation of output files. The following macros are supported in the file name: {Basename} - An expansion macro that will use the name of the input video file. If the base name(the file suffix is not included) of the input video file is less than 32 characters long, the base name of input video files will be used. If the length of base name of the input video file exceeds 32 characters, the base name is truncated to the first 32 characters in total length. {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {AudioStream} - string "Audio" plus audio stream number(start from 1). {Bitrate} - The audio/video bitrate in kbps. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. {Resolution} - The video resolution. Any unsubstituted macros will be collapsed and removed from the filename. |
InputFile
An InputDefinition for a single file. TrackSelections are scoped to the file specified.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.InputFile |
The discriminator for derived types. |
| filename | string | Name of the file that this input definition applies to. |
| includedTracks | TrackDescriptor : |
The list of TrackDescriptors which define the metadata and selection of tracks in the input. |
InterleaveOutput
Sets the interleave mode of the output to control how audio and video are stored in the container format. Example: set InterleavedOutput as NonInterleavedOutput to produce audio-only and video-only outputs in separate MP4 files.
| Name | Type | Description |
|---|---|---|
| InterleavedOutput | string | The output includes both audio and video. |
| NonInterleavedOutput | string | The output is video-only or audio-only. |
Job
A Job resource type. The progress and state can be obtained by polling a Job or subscribing to events using EventGrid.
| Name | Type | Description |
|---|---|---|
| id | string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resource
|
| name | string | The name of the resource |
| properties.correlationData | object | Customer provided key, value pairs that will be returned in Job and JobOutput state events. |
| properties.created | string | The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. |
| properties.description | string | Optional customer supplied description of the Job. |
| properties.endTime | string | The UTC date and time at which this Job finished processing. |
| properties.input | JobInput: |
The inputs for the Job. |
| properties.lastModified | string | The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. |
| properties.outputs | JobOutput : | The outputs for the Job. |
| properties.priority | Priority | Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal. |
| properties.startTime | string | The UTC date and time at which this Job began processing. |
| properties.state | JobState | The current state of the job. |
| systemData | systemData | The system metadata relating to this resource. |
| type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
JobCollection
A collection of Job items.
| Name | Type | Description |
|---|---|---|
| @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 | Job | A collection of Job items. |
JobError
Details of JobOutput errors.
| Name | Type | Description |
|---|---|---|
| category | JobErrorCategory | Helps with categorization of errors. |
| code | JobErrorCode | Error code describing the error. |
| details | JobErrorDetail | An array of details about specific errors that led to this reported error. |
| message | string | A human-readable language-dependent representation of the error. |
| retry | JobRetry | Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. |
JobErrorCategory
Helps with categorization of errors.
| Name | Type | Description |
|---|---|---|
| Account | string | The error is related to account information. |
| Configuration | string | The error is configuration related. |
| Content | string | The error is related to data in the input files. |
| Download | string | The error is download related. |
| Service | string | The error is service related. |
| Upload | string | The error is upload related. |
JobErrorCode
Error code describing the error.
| Name | Type | Description |
|---|---|---|
| ConfigurationUnsupported | string | There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration. |
| ContentMalformed | string | There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files. |
| ContentUnsupported | string | There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files. |
| DownloadNotAccessible | string | While trying to download the input files, the files were not accessible, please check the availability of the source. |
| DownloadTransientError | string | While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source. |
| IdentityUnsupported | string | There was an error verifying to the account identity. Check and fix the identity configurations and retry. If unsuccessful, please contact support. |
| ServiceError | string | Fatal service error, please contact support. |
| ServiceTransientError | string | Transient error, please retry, if retry is unsuccessful, please contact support. |
| UploadNotAccessible | string | While trying to upload the output files, the destination was not reachable, please check the availability of the destination. |
| UploadTransientError | string | While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination. |
JobErrorDetail
Details of JobOutput errors.
| Name | Type | Description |
|---|---|---|
| code | string | Code describing the error detail. |
| message | string | A human-readable representation of the error. |
JobInputAsset
Represents an Asset for input into a Job.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.JobInputAsset |
The discriminator for derived types. |
| assetName | string | The name of the input Asset. |
| end | ClipTime: |
Defines a point on the timeline of the input media at which processing will end. Defaults to the end of the input media. |
| files | string | List of files. Required for JobInputHttp. Maximum of 4000 characters each. Query strings will not be returned in service responses to prevent sensitive data exposure. |
| inputDefinitions | InputDefinition : |
Defines a list of InputDefinitions. For each InputDefinition, it defines a list of track selections and related metadata. |
| label | string | A label that is assigned to a JobInputClip, that is used to satisfy a reference used in the Transform. For example, a Transform can be authored so as to take an image file with the label 'xyz' and apply it as an overlay onto the input video before it is encoded. When submitting a Job, exactly one of the JobInputs should be the image file, and it should have the label 'xyz'. |
| start | ClipTime: |
Defines a point on the timeline of the input media at which processing will start. Defaults to the beginning of the input media. |
JobInputClip
Represents input files for a Job.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.JobInputClip |
The discriminator for derived types. |
| end | ClipTime: |
Defines a point on the timeline of the input media at which processing will end. Defaults to the end of the input media. |
| files | string | List of files. Required for JobInputHttp. Maximum of 4000 characters each. Query strings will not be returned in service responses to prevent sensitive data exposure. |
| inputDefinitions | InputDefinition : |
Defines a list of InputDefinitions. For each InputDefinition, it defines a list of track selections and related metadata. |
| label | string | A label that is assigned to a JobInputClip, that is used to satisfy a reference used in the Transform. For example, a Transform can be authored so as to take an image file with the label 'xyz' and apply it as an overlay onto the input video before it is encoded. When submitting a Job, exactly one of the JobInputs should be the image file, and it should have the label 'xyz'. |
| start | ClipTime: |
Defines a point on the timeline of the input media at which processing will start. Defaults to the beginning of the input media. |
JobInputHttp
Represents HTTPS job input.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.JobInputHttp |
The discriminator for derived types. |
| baseUri | string | Base URI for HTTPS job input. It will be concatenated with provided file names. If no base uri is given, then the provided file list is assumed to be fully qualified uris. Maximum length of 4000 characters. The query strings will not be returned in service responses to prevent sensitive data exposure. |
| end | ClipTime: |
Defines a point on the timeline of the input media at which processing will end. Defaults to the end of the input media. |
| files | string | List of files. Required for JobInputHttp. Maximum of 4000 characters each. Query strings will not be returned in service responses to prevent sensitive data exposure. |
| inputDefinitions | InputDefinition : |
Defines a list of InputDefinitions. For each InputDefinition, it defines a list of track selections and related metadata. |
| label | string | A label that is assigned to a JobInputClip, that is used to satisfy a reference used in the Transform. For example, a Transform can be authored so as to take an image file with the label 'xyz' and apply it as an overlay onto the input video before it is encoded. When submitting a Job, exactly one of the JobInputs should be the image file, and it should have the label 'xyz'. |
| start | ClipTime: |
Defines a point on the timeline of the input media at which processing will start. Defaults to the beginning of the input media. |
JobInputs
Describes a list of inputs to a Job.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.JobInputs |
The discriminator for derived types. |
| inputs | JobInput : |
List of inputs to a Job. |
JobInputSequence
A Sequence contains an ordered list of Clips where each clip is a JobInput. The Sequence will be treated as a single input.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.JobInputSequence |
The discriminator for derived types. |
| inputs | JobInputClip : |
JobInputs that make up the timeline. |
JobOutputAsset
Represents an Asset used as a JobOutput.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.JobOutputAsset |
The discriminator for derived types. |
| assetName | string | The name of the output Asset. |
| endTime | string | The UTC date and time at which this Job Output finished processing. |
| error | JobError | If the JobOutput is in the Error state, it contains the details of the error. |
| label | string | A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform. |
| presetOverride | Preset: |
A preset used to override the preset in the corresponding transform output. |
| progress | integer | If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. |
| startTime | string | The UTC date and time at which this Job Output began processing. |
| state | JobState | Describes the state of the JobOutput. |
JobRetry
Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal.
| Name | Type | Description |
|---|---|---|
| DoNotRetry | string | Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected. |
| MayRetry | string | Issue may be resolved after waiting for a period of time and resubmitting the same Job. |
JobState
Describes the state of the JobOutput.
| Name | Type | Description |
|---|---|---|
| Canceled | string | The job was canceled. This is a final state for the job. |
| Canceling | string | The job is in the process of being canceled. This is a transient state for the job. |
| Error | string | The job has encountered an error. This is a final state for the job. |
| Finished | string | The job is finished. This is a final state for the job. |
| Processing | string | The job is processing. This is a transient state for the job. |
| Queued | string | The job is in a queued state, waiting for resources to become available. This is a transient state. |
| Scheduled | string | The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. |
JpgFormat
Describes the settings for producing JPEG thumbnails.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.JpgFormat |
The discriminator for derived types. |
| filenamePattern | string |
The file naming pattern used for the creation of output files. The following macros are supported in the file name: {Basename} - An expansion macro that will use the name of the input video file. If the base name(the file suffix is not included) of the input video file is less than 32 characters long, the base name of input video files will be used. If the length of base name of the input video file exceeds 32 characters, the base name is truncated to the first 32 characters in total length. {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {AudioStream} - string "Audio" plus audio stream number(start from 1). {Bitrate} - The audio/video bitrate in kbps. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. {Resolution} - The video resolution. Any unsubstituted macros will be collapsed and removed from the filename. |
JpgImage
Describes the properties for producing a series of JPEG images from the input video.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.JpgImage |
The discriminator for derived types. |
| keyFrameInterval | string | The distance between two key frames. The value should be non-zero in the range [0.5, 20] seconds, specified in ISO 8601 format. The default is 2 seconds(PT2S). Note that this setting is ignored if VideoSyncMode.Passthrough is set, where the KeyFrameInterval value will follow the input source setting. |
| label | string | An optional label for the codec. The label can be used to control muxing behavior. |
| layers | JpgLayer | A collection of output JPEG image layers to be produced by the encoder. |
| range | string | The position relative to transform preset start time in the input video at which to stop generating thumbnails. The value can be in ISO 8601 format (For example, PT5M30S to stop at 5 minutes and 30 seconds from start time), or a frame count (For example, 300 to stop at the 300th frame from the frame at start time. If this value is 1, it means only producing one thumbnail at start time), or a relative value to the stream duration (For example, 50% to stop at half of stream duration from start time). The default value is 100%, which means to stop at the end of the stream. |
| spriteColumn | integer | Sets the number of columns used in thumbnail sprite image. The number of rows are automatically calculated and a VTT file is generated with the coordinate mappings for each thumbnail in the sprite. Note: this value should be a positive integer and a proper value is recommended so that the output image resolution will not go beyond JPEG maximum pixel resolution limit 65535x65535. |
| start | string | The position in the input video from where to start generating thumbnails. The value can be in ISO 8601 format (For example, PT05S to start at 5 seconds), or a frame count (For example, 10 to start at the 10th frame), or a relative value to stream duration (For example, 10% to start at 10% of stream duration). Also supports a macro {Best}, which tells the encoder to select the best thumbnail from the first few seconds of the video and will only produce one thumbnail, no matter what other settings are for Step and Range. The default value is macro {Best}. |
| step | string | The intervals at which thumbnails are generated. The value can be in ISO 8601 format (For example, PT05S for one image every 5 seconds), or a frame count (For example, 30 for one image every 30 frames), or a relative value to stream duration (For example, 10% for one image every 10% of stream duration). Note: Step value will affect the first generated thumbnail, which may not be exactly the one specified at transform preset start time. This is due to the encoder, which tries to select the best thumbnail between start time and Step position from start time as the first output. As the default value is 10%, it means if stream has long duration, the first generated thumbnail might be far away from the one specified at start time. Try to select reasonable value for Step if the first thumbnail is expected close to start time, or set Range value at 1 if only one thumbnail is needed at start time. |
| stretchMode | StretchMode | The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize |
| syncMode | VideoSyncMode | The Video Sync Mode |
JpgLayer
Describes the settings to produce a JPEG image from the input video.
| Name | Type | Description |
|---|---|---|
| height | string | The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input. |
| label | string | The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. |
| quality | integer | The compression quality of the JPEG output. Range is from 0-100 and the default is 70. |
| width | string | The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input. |
Mp4Format
Describes the properties for an output ISO MP4 file.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media. Mp4Format |
The discriminator for derived types. |
| filenamePattern | string |
The file naming pattern used for the creation of output files. The following macros are supported in the file name: {Basename} - An expansion macro that will use the name of the input video file. If the base name(the file suffix is not included) of the input video file is less than 32 characters long, the base name of input video files will be used. If the length of base name of the input video file exceeds 32 characters, the base name is truncated to the first 32 characters in total length. {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {AudioStream} - string "Audio" plus audio stream number(start from 1). {Bitrate} - The audio/video bitrate in kbps. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. {Resolution} - The video resolution. Any unsubstituted macros will be collapsed and removed from the filename. |
| outputFiles | OutputFile | The list of output files to produce. Each entry in the list is a set of audio and video layer labels to be muxed together . |
MultiBitrateFormat
Describes the properties for producing a collection of GOP aligned multi-bitrate files. The default behavior is to produce one output file for each video layer which is muxed together with all the audios. The exact output files produced can be controlled by specifying the outputFiles collection.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.MultiBitrateFormat |
The discriminator for derived types. |
| filenamePattern | string | The file naming pattern used for the creation of output files. The following macros are supported in the file name: {Basename} - An expansion macro that will use the name of the input video file. If the base name(the file suffix is not included) of the input video file is less than 32 characters long, the base name of input video files will be used. If the length of base name of the input video file exceeds 32 characters, the base name is truncated to the first 32 characters in total length. {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {AudioStream} - string "Audio" plus audio stream number(start from 1). {Bitrate} - The audio/video bitrate in kbps. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. {Resolution} - The video resolution. Any unsubstituted macros will be collapsed and removed from the filename. |
| outputFiles | OutputFile | The list of output files to produce. Each entry in the list is a set of audio and video layer labels to be muxed together . |
OutputFile
Represents an output file produced.
| Name | Type | Description |
|---|---|---|
| labels | string | The list of labels that describe how the encoder should multiplex video and audio into an output file. For example, if the encoder is producing two video layers with labels v1 and v2, and one audio layer with label a1, then an array like '[v1, a1]' tells the encoder to produce an output file with the video track represented by v1 and the audio track represented by a1. |
PngFormat
Describes the settings for producing PNG thumbnails.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.PngFormat |
The discriminator for derived types. |
| filenamePattern | string |
The file naming pattern used for the creation of output files. The following macros are supported in the file name: {Basename} - An expansion macro that will use the name of the input video file. If the base name(the file suffix is not included) of the input video file is less than 32 characters long, the base name of input video files will be used. If the length of base name of the input video file exceeds 32 characters, the base name is truncated to the first 32 characters in total length. {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {AudioStream} - string "Audio" plus audio stream number(start from 1). {Bitrate} - The audio/video bitrate in kbps. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. {Resolution} - The video resolution. Any unsubstituted macros will be collapsed and removed from the filename. |
PngImage
Describes the properties for producing a series of PNG images from the input video.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.PngImage |
The discriminator for derived types. |
| keyFrameInterval | string | The distance between two key frames. The value should be non-zero in the range [0.5, 20] seconds, specified in ISO 8601 format. The default is 2 seconds(PT2S). Note that this setting is ignored if VideoSyncMode.Passthrough is set, where the KeyFrameInterval value will follow the input source setting. |
| label | string | An optional label for the codec. The label can be used to control muxing behavior. |
| layers | PngLayer | A collection of output PNG image layers to be produced by the encoder. |
| range | string | The position relative to transform preset start time in the input video at which to stop generating thumbnails. The value can be in ISO 8601 format (For example, PT5M30S to stop at 5 minutes and 30 seconds from start time), or a frame count (For example, 300 to stop at the 300th frame from the frame at start time. If this value is 1, it means only producing one thumbnail at start time), or a relative value to the stream duration (For example, 50% to stop at half of stream duration from start time). The default value is 100%, which means to stop at the end of the stream. |
| start | string | The position in the input video from where to start generating thumbnails. The value can be in ISO 8601 format (For example, PT05S to start at 5 seconds), or a frame count (For example, 10 to start at the 10th frame), or a relative value to stream duration (For example, 10% to start at 10% of stream duration). Also supports a macro {Best}, which tells the encoder to select the best thumbnail from the first few seconds of the video and will only produce one thumbnail, no matter what other settings are for Step and Range. The default value is macro {Best}. |
| step | string | The intervals at which thumbnails are generated. The value can be in ISO 8601 format (For example, PT05S for one image every 5 seconds), or a frame count (For example, 30 for one image every 30 frames), or a relative value to stream duration (For example, 10% for one image every 10% of stream duration). Note: Step value will affect the first generated thumbnail, which may not be exactly the one specified at transform preset start time. This is due to the encoder, which tries to select the best thumbnail between start time and Step position from start time as the first output. As the default value is 10%, it means if stream has long duration, the first generated thumbnail might be far away from the one specified at start time. Try to select reasonable value for Step if the first thumbnail is expected close to start time, or set Range value at 1 if only one thumbnail is needed at start time. |
| stretchMode | StretchMode | The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize |
| syncMode | VideoSyncMode | The Video Sync Mode |
PngLayer
Describes the settings to produce a PNG image from the input video.
| Name | Type | Description |
|---|---|---|
| height | string | The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input. |
| label | string | The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file. |
| width | string | The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input. |
PresetConfigurations
An object of optional configuration settings for encoder.
| Name | Type | Description |
|---|---|---|
| complexity | Complexity | Allows you to configure the encoder settings to control the balance between speed and quality. Example: set Complexity as Speed for faster encoding but less compression efficiency. |
| interleaveOutput | InterleaveOutput | Sets the interleave mode of the output to control how audio and video are stored in the container format. Example: set InterleavedOutput as NonInterleavedOutput to produce audio-only and video-only outputs in separate MP4 files. |
| keyFrameIntervalInSeconds | number | The key frame interval in seconds. Example: set KeyFrameIntervalInSeconds as 2 to reduce the playback buffering for some players. |
| maxBitrateBps | integer | The maximum bitrate in bits per second (threshold for the top video layer). Example: set MaxBitrateBps as 6000000 to avoid producing very high bitrate outputs for contents with high complexity. |
| maxHeight | integer | The maximum height of output video layers. Example: set MaxHeight as 720 to produce output layers up to 720P even if the input is 4K. |
| maxLayers | integer | The maximum number of output video layers. Example: set MaxLayers as 4 to make sure at most 4 output layers are produced to control the overall cost of the encoding job. |
| minBitrateBps | integer | The minimum bitrate in bits per second (threshold for the bottom video layer). Example: set MinBitrateBps as 200000 to have a bottom layer that covers users with low network bandwidth. |
| minHeight | integer | The minimum height of output video layers. Example: set MinHeight as 360 to avoid output layers of smaller resolutions like 180P. |
Priority
Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal.
| Name | Type | Description |
|---|---|---|
| High | string | Used for TransformOutputs that should take precedence over others. |
| Low | string | Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. |
| Normal | string | Used for TransformOutputs that can be generated at Normal priority. |
Rectangle
Describes the properties of a rectangular window applied to the input media before processing it.
| Name | Type | Description |
|---|---|---|
| height | string | The height of the rectangular region in pixels. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%). |
| left | string | The number of pixels from the left-margin. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%). |
| top | string | The number of pixels from the top-margin. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%). |
| width | string | The width of the rectangular region in pixels. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%). |
Rotation
The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto
| Name | Type | Description |
|---|---|---|
| Auto | string | Automatically detect and rotate as needed. |
| None | string | Do not rotate the video. If the output format supports it, any metadata about rotation is kept intact. |
| Rotate0 | string | Do not rotate the video but remove any metadata about the rotation. |
| Rotate180 | string | Rotate 180 degrees clockwise. |
| Rotate270 | string | Rotate 270 degrees clockwise. |
| Rotate90 | string | Rotate 90 degrees clockwise. |
SelectAudioTrackByAttribute
Select audio tracks from the input by specifying an attribute and an attribute filter.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.SelectAudioTrackByAttribute |
The discriminator for derived types. |
| attribute | TrackAttribute | The TrackAttribute to filter the tracks by. |
| filter | AttributeFilter | The type of AttributeFilter to apply to the TrackAttribute in order to select the tracks. |
| filterValue | string | The value to filter the tracks by. Only used when AttributeFilter.ValueEquals is specified for the Filter property. |
SelectAudioTrackById
Select audio tracks from the input by specifying a track identifier.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.SelectAudioTrackById |
The discriminator for derived types. |
| trackId | integer | Track identifier to select |
SelectVideoTrackByAttribute
Select video tracks from the input by specifying an attribute and an attribute filter.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.SelectVideoTrackByAttribute |
The discriminator for derived types. |
| attribute | TrackAttribute | The TrackAttribute to filter the tracks by. |
| filter | AttributeFilter | The type of AttributeFilter to apply to the TrackAttribute in order to select the tracks. |
| filterValue | string | The value to filter the tracks by. Only used when AttributeFilter.ValueEquals is specified for the Filter property. For TrackAttribute.Bitrate, this should be an integer value in bits per second (e.g: '1500000'). The TrackAttribute.Language is not supported for video tracks. |
SelectVideoTrackById
Select video tracks from the input by specifying a track identifier.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.SelectVideoTrackById |
The discriminator for derived types. |
| trackId | integer | Track identifier to select |
StandardEncoderPreset
Describes all the settings to be used when encoding the input video with the Standard Encoder.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.StandardEncoderPreset |
The discriminator for derived types. |
| codecs | Codec : |
The list of codecs to be used when encoding the input video. |
| experimentalOptions | object | Dictionary containing key value pairs for parameters not exposed in the preset itself |
| filters | Filters | One or more filtering operations that are applied to the input media before encoding. |
| formats | Format : |
The list of outputs to be produced by the encoder. |
StretchMode
The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize
| Name | Type | Description |
|---|---|---|
| AutoFit | string | Pad the output (with either letterbox or pillar box) to honor the output resolution, while ensuring that the active video region in the output has the same aspect ratio as the input. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the output will be at 1280x1280, which contains an inner rectangle of 1280x720 at aspect ratio of 16:9, and pillar box regions 280 pixels wide at the left and right. |
| AutoSize | string | Override the output resolution, and change it to match the display aspect ratio of the input, without padding. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the value in the preset is overridden, and the output will be at 1280x720, which maintains the input aspect ratio of 16:9. |
| None | string | Strictly respect the output resolution without considering the pixel aspect ratio or display aspect ratio of the input video. |
systemData
Metadata pertaining to creation and last modification of the resource.
| Name | Type | Description |
|---|---|---|
| createdAt | string | The timestamp of resource creation (UTC). |
| createdBy | string | The identity that created the resource. |
| createdByType | createdByType | The type of identity that created the resource. |
| lastModifiedAt | string | The timestamp of resource last modification (UTC) |
| lastModifiedBy | string | The identity that last modified the resource. |
| lastModifiedByType | createdByType | The type of identity that last modified the resource. |
TrackAttribute
The TrackAttribute to filter the tracks by.
| Name | Type | Description |
|---|---|---|
| Bitrate | string | The bitrate of the track. |
| Language | string | The language of the track. |
UtcClipTime
Specifies the clip time as a Utc time position in the media file. The Utc time can point to a different position depending on whether the media file starts from a timestamp of zero or not.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.UtcClipTime |
The discriminator for derived types. |
| time | string | The time position on the timeline of the input media based on Utc time. |
Video
Describes the basic properties for encoding the input video.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.Video |
The discriminator for derived types. |
| keyFrameInterval | string | The distance between two key frames. The value should be non-zero in the range [0.5, 20] seconds, specified in ISO 8601 format. The default is 2 seconds(PT2S). Note that this setting is ignored if VideoSyncMode.Passthrough is set, where the KeyFrameInterval value will follow the input source setting. |
| label | string | An optional label for the codec. The label can be used to control muxing behavior. |
| stretchMode | StretchMode | The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize |
| syncMode | VideoSyncMode | The Video Sync Mode |
VideoOverlay
Describes the properties of a video overlay.
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.VideoOverlay |
The discriminator for derived types. |
| audioGainLevel | number | The gain level of audio in the overlay. The value should be in the range [0, 1.0]. The default is 1.0. |
| cropRectangle | Rectangle | An optional rectangular window used to crop the overlay image or video. |
| end | string | The end position, with reference to the input video, at which the overlay ends. The value should be in ISO 8601 format. For example, PT30S to end the overlay at 30 seconds into the input video. If not specified or the value is greater than the input video duration, the overlay will be applied until the end of the input video if the overlay media duration is greater than the input video duration, else the overlay will last as long as the overlay media duration. |
| fadeInDuration | string | The duration over which the overlay fades in onto the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade in (same as PT0S). |
| fadeOutDuration | string | The duration over which the overlay fades out of the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade out (same as PT0S). |
| inputLabel | string | The label of the job input which is to be used as an overlay. The Input must specify exactly one file. You can specify an image file in JPG, PNG, GIF or BMP format, or an audio file (such as a WAV, MP3, WMA or M4A file), or a video file. See https://aka.ms/mesformats for the complete list of supported audio and video file formats. |
| opacity | number | The opacity of the overlay. This is a value in the range [0 - 1.0]. Default is 1.0 which mean the overlay is opaque. |
| position | Rectangle | The location in the input video where the overlay is applied. |
| start | string | The start position, with reference to the input video, at which the overlay starts. The value should be in ISO 8601 format. For example, PT05S to start the overlay at 5 seconds into the input video. If not specified the overlay starts from the beginning of the input video. |
VideoSyncMode
The Video Sync Mode
| Name | Type | Description |
|---|---|---|
| Auto | string | This is the default method. Chooses between Cfr and Vfr depending on muxer capabilities. For output format MP4, the default mode is Cfr. |
| Cfr | string | Input frames will be repeated and/or dropped as needed to achieve exactly the requested constant frame rate. Recommended when the output frame rate is explicitly set at a specified value |
| Passthrough | string | The presentation timestamps on frames are passed through from the input file to the output file writer. Recommended when the input source has variable frame rate, and are attempting to produce multiple layers for adaptive streaming in the output which have aligned GOP boundaries. Note: if two or more frames in the input have duplicate timestamps, then the output will also have the same behavior |
| Vfr | string | Similar to the Passthrough mode, but if the input has frames that have duplicate timestamps, then only one frame is passed through to the output, and others are dropped. Recommended when the number of output frames is expected to be equal to the number of input frames. For example, the output is used to calculate a quality metric like PSNR against the input |
VideoTrackDescriptor
A TrackSelection to select video tracks.table
| Name | Type | Description |
|---|---|---|
| @odata.type | string:
#Microsoft.Media.VideoTrackDescriptor |
The discriminator for derived types. |