Microsoft.Media mediaServices/mediaGraphs

ARM template resource definition

The mediaServices/mediaGraphs resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Media/mediaServices/mediaGraphs resource, add the following JSON to your template.

{
  "type": "Microsoft.Media/mediaServices/mediaGraphs",
  "apiVersion": "2020-02-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "sinks": [
      {
        "inputs": [ "string" ],
        "name": "string",
        "@odata.type": "string"
        // For remaining properties, see MediaGraphSink objects
      }
    ],
    "sources": [
      {
        "name": "string",
        "@odata.type": "string"
        // For remaining properties, see MediaGraphSource objects
      }
    ]
  }
}

MediaGraphSink objects

Set the @odata.type property to specify the type of object.

For #Microsoft.Media.MediaGraphAssetSink, use:

  "@odata.type": "#Microsoft.Media.MediaGraphAssetSink",
  "assetName": "string"

MediaGraphSource objects

Set the @odata.type property to specify the type of object.

For #Microsoft.Media.MediaGraphRtspSource, use:

  "@odata.type": "#Microsoft.Media.MediaGraphRtspSource",
  "endpoint": {
    "credentials": {
      "@odata.type": "string"
      // For remaining properties, see MediaGraphCredentials objects
    },
    "url": "string",
    "@odata.type": "string"
    // For remaining properties, see MediaGraphEndpoint objects
  },
  "transport": "string"

MediaGraphEndpoint objects

Set the @odata.type property to specify the type of object.

For #Microsoft.Media.MediaGraphClearEndpoint, use:

  "@odata.type": "#Microsoft.Media.MediaGraphClearEndpoint"

For #Microsoft.Media.MediaGraphTlsEndpoint, use:

  "@odata.type": "#Microsoft.Media.MediaGraphTlsEndpoint",
  "trustedCertificates": {
    "@odata.type": "string"
    // For remaining properties, see MediaGraphCertificateSource objects
  },
  "validationOptions": {
    "ignoreHostname": "bool",
    "ignoreSignature": "bool"
  }

MediaGraphCredentials objects

Set the @odata.type property to specify the type of object.

For #Microsoft.Media.MediaGraphUsernamePasswordCredentials, use:

  "@odata.type": "#Microsoft.Media.MediaGraphUsernamePasswordCredentials",
  "password": "string",
  "username": "string"

MediaGraphCertificateSource objects

Set the @odata.type property to specify the type of object.

For #Microsoft.Media.MediaGraphPemCertificateList, use:

  "@odata.type": "#Microsoft.Media.MediaGraphPemCertificateList",
  "certificates": [ "string" ]

Property values

mediaServices/mediaGraphs

Name Description Value
type The resource type 'Microsoft.Media/mediaServices/mediaGraphs'
apiVersion The resource api version '2020-02-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
properties Class for Media Graph properties. MediaGraphProperties

MediaGraphProperties

Name Description Value
description Media Graph description. string
sinks Media Graph sinks. MediaGraphSink[] (required)
sources Media Graph sources. MediaGraphSource[] (required)

MediaGraphSink

Name Description Value
inputs Sink inputs. string[] (required)
name Sink name. string (required)
@odata.type Set the object type #Microsoft.Media.MediaGraphAssetSink (required)

MediaGraphAssetSink

Name Description Value
@odata.type The discriminator for derived types. '#Microsoft.Media.MediaGraphAssetSink' (required)
assetName Asset name. string (required)

MediaGraphSource

Name Description Value
name Source name. string (required)
@odata.type Set the object type #Microsoft.Media.MediaGraphRtspSource (required)

MediaGraphRtspSource

Name Description Value
@odata.type The discriminator for derived types. '#Microsoft.Media.MediaGraphRtspSource' (required)
endpoint RTSP endpoint of the stream being connected to. MediaGraphEndpoint (required)
transport Underlying RTSP transport. This can be used to enable or disable HTTP tunneling. 'Http'
'Tcp' (required)

MediaGraphEndpoint

Name Description Value
credentials Polymorphic credentials to present to the endpoint. MediaGraphCredentials
url Url for the endpoint. string (required)
@odata.type Set the object type #Microsoft.Media.MediaGraphClearEndpoint
#Microsoft.Media.MediaGraphTlsEndpoint (required)

MediaGraphCredentials

Name Description Value
@odata.type Set the object type #Microsoft.Media.MediaGraphUsernamePasswordCredentials (required)

MediaGraphUsernamePasswordCredentials

Name Description Value
@odata.type The discriminator for derived types. '#Microsoft.Media.MediaGraphUsernamePasswordCredentials' (required)
password Password for a username/password pair. string (required)
username Username for a username/password pair. string (required)

MediaGraphClearEndpoint

Name Description Value
@odata.type The discriminator for derived types. '#Microsoft.Media.MediaGraphClearEndpoint' (required)

MediaGraphTlsEndpoint

Name Description Value
@odata.type The discriminator for derived types. '#Microsoft.Media.MediaGraphTlsEndpoint' (required)
trustedCertificates What certificates should be trusted when authenticating a TLS connection. Null designates that Azure Media's source of trust should be used. MediaGraphCertificateSource
validationOptions Validation options to use when authenticating a TLS connection. By default, strict validation is used. MediaGraphTlsValidationOptions

MediaGraphCertificateSource

Name Description Value
@odata.type Set the object type #Microsoft.Media.MediaGraphPemCertificateList (required)

MediaGraphPemCertificateList

Name Description Value
@odata.type The discriminator for derived types. '#Microsoft.Media.MediaGraphPemCertificateList' (required)
certificates PEM formatted public certificates, one per entry. string[] (required)

MediaGraphTlsValidationOptions

Name Description Value
ignoreHostname Ignore the host name (common name) during validation. bool (required)
ignoreSignature Ignore the integrity of the certificate chain at the current time. bool (required)