Streaming Endpoints - Create

Create StreamingEndpoint
Creates a streaming endpoint.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}?api-version=2020-05-01
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}?api-version=2020-05-01&autoStart={autoStart}

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.

streamingEndpointName
path True
  • string

The name of the streaming endpoint, maximum length is 24.

Regex pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$

subscriptionId
path True
  • string

The unique identifier for a Microsoft Azure subscription.

api-version
query True
  • string

The version of the API to be used with the client request.

autoStart
query
  • boolean

The flag indicates if the resource should be automatically started on creation.

Request Body

Name Required Type Description
location True
  • string

The geo-location where the resource lives

properties.scaleUnits True
  • integer

The number of scale units. Use the Scale operation to adjust this value.

properties.accessControl

The access control definition of the streaming endpoint.

properties.availabilitySetName
  • string

This feature is deprecated, do not set a value for this property.

properties.cdnEnabled
  • boolean

The CDN enabled flag.

properties.cdnProfile
  • string

The CDN profile name.

properties.cdnProvider
  • string

The CDN provider name.

properties.crossSiteAccessPolicies

The streaming endpoint access policies.

properties.customHostNames
  • string[]

The custom host names of the streaming endpoint

properties.description
  • string

The streaming endpoint description.

properties.maxCacheAge
  • integer

Max cache age

tags
  • object

Resource tags.

Responses

Name Type Description
200 OK

OK. The request has succeeded.

201 Created

Created. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on monitoring asynchronous Azure operations using the Azure-AsyncOperation response header.

Other Status Codes

The streaming error response describing why the operation failed.

Examples

Create a streaming endpoint

Sample Request

PUT https://management.azure.com/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingEndpoints/myStreamingEndpoint1?api-version=2020-05-01
{
  "location": "West US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "description": "test event 1",
    "scaleUnits": 1,
    "availabilitySetName": "availableset",
    "accessControl": {
      "akamai": {
        "akamaiSignatureHeaderAuthenticationKeyList": [
          {
            "identifier": "id1",
            "expiration": "2029-12-31T16:00:00-08:00",
            "base64Key": "dGVzdGlkMQ=="
          },
          {
            "identifier": "id2",
            "expiration": "2030-12-31T16:00:00-08:00",
            "base64Key": "dGVzdGlkMQ=="
          }
        ]
      },
      "ip": {
        "allow": [
          {
            "name": "AllowedIp",
            "address": "192.168.1.1"
          }
        ]
      }
    },
    "cdnEnabled": false
  }
}

Sample Response

{
  "name": "myStreamingEndpoint1",
  "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1",
  "type": "Microsoft.Media/mediaservices/streamingEndpoints",
  "location": "West US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "description": "test event 1",
    "scaleUnits": 1,
    "availabilitySetName": "availableset",
    "cdnEnabled": false,
    "cdnProvider": null,
    "cdnProfile": "",
    "customHostNames": [],
    "accessControl": {
      "akamai": {
        "akamaiSignatureHeaderAuthenticationKeyList": [
          {
            "identifier": "id1",
            "expiration": "2030-01-01T00:00:00Z",
            "base64Key": "dGVzdGlkMQ=="
          },
          {
            "identifier": "id2",
            "expiration": "2031-01-01T00:00:00Z",
            "base64Key": "dGVzdGlkMQ=="
          }
        ]
      },
      "ip": {
        "allow": [
          {
            "name": "AllowedIp",
            "address": "192.168.1.1",
            "subnetPrefixLength": null
          }
        ]
      }
    },
    "maxCacheAge": null,
    "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net",
    "freeTrialEndTime": "0001-01-01T00:00:00-08:00",
    "provisioningState": "InProgress",
    "resourceState": "Creating",
    "created": "2018-03-03T02:25:09.7561389Z",
    "lastModified": "2018-03-03T02:25:09.7561389Z"
  }
}
{
  "name": "myStreamingEndpoint1",
  "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1",
  "type": "Microsoft.Media/mediaservices/streamingEndpoints",
  "location": "West US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "description": "test event 1",
    "scaleUnits": 1,
    "availabilitySetName": "availableset",
    "cdnEnabled": false,
    "cdnProvider": null,
    "cdnProfile": "",
    "customHostNames": [],
    "accessControl": {
      "akamai": {
        "akamaiSignatureHeaderAuthenticationKeyList": [
          {
            "identifier": "id1",
            "expiration": "2030-01-01T00:00:00Z",
            "base64Key": "dGVzdGlkMQ=="
          },
          {
            "identifier": "id2",
            "expiration": "2031-01-01T00:00:00Z",
            "base64Key": "dGVzdGlkMQ=="
          }
        ]
      },
      "ip": {
        "allow": [
          {
            "name": "AllowedIp",
            "address": "192.168.1.1",
            "subnetPrefixLength": null
          }
        ]
      }
    },
    "maxCacheAge": null,
    "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net",
    "freeTrialEndTime": "0001-01-01T00:00:00-08:00",
    "provisioningState": "Succeeded",
    "resourceState": "Stopped",
    "created": "2018-03-03T02:25:09.7561389Z",
    "lastModified": "2018-03-03T02:25:09.7561389Z"
  }
}

Definitions

AkamaiAccessControl

Akamai access control

AkamaiSignatureHeaderAuthenticationKey

Akamai Signature Header authentication key.

ApiError

The API error.

createdByType

The type of identity that created the resource.

CrossSiteAccessPolicies

The client access policy.

IPAccessControl

The IP access control.

IPRange

The IP address range in the CIDR scheme.

ODataError

Information about an error.

StreamingEndpoint

The streaming endpoint.

StreamingEndpointAccessControl

Streaming endpoint access control definition.

StreamingEndpointResourceState

The resource state of the streaming endpoint.

systemData

Metadata pertaining to creation and last modification of the resource.

AkamaiAccessControl

Akamai access control

Name Type Description
akamaiSignatureHeaderAuthenticationKeyList

authentication key list

AkamaiSignatureHeaderAuthenticationKey

Akamai Signature Header authentication key.

Name Type Description
base64Key
  • string

authentication key

expiration
  • string

The expiration time of the authentication key.

identifier
  • string

identifier of the key

ApiError

The API error.

Name Type Description
error

The error properties.

createdByType

The type of identity that created the resource.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

CrossSiteAccessPolicies

The client access policy.

Name Type Description
clientAccessPolicy
  • string

The content of clientaccesspolicy.xml used by Silverlight.

crossDomainPolicy
  • string

The content of crossdomain.xml used by Silverlight.

IPAccessControl

The IP access control.

Name Type Description
allow

The IP allow list.

IPRange

The IP address range in the CIDR scheme.

Name Type Description
address
  • string

The IP address.

name
  • string

The friendly name for the IP address range.

subnetPrefixLength
  • integer

The subnet mask prefix length (see CIDR notation).

ODataError

Information about an error.

Name Type Description
code
  • string

A language-independent error name.

details

The error details.

message
  • string

The error message.

target
  • string

The target of the error (for example, the name of the property in error).

StreamingEndpoint

The streaming endpoint.

Name Type Description
id
  • string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location
  • string

The geo-location where the resource lives

name
  • string

The name of the resource

properties.accessControl

The access control definition of the streaming endpoint.

properties.availabilitySetName
  • string

This feature is deprecated, do not set a value for this property.

properties.cdnEnabled
  • boolean

The CDN enabled flag.

properties.cdnProfile
  • string

The CDN profile name.

properties.cdnProvider
  • string

The CDN provider name.

properties.created
  • string

The exact time the streaming endpoint was created.

properties.crossSiteAccessPolicies

The streaming endpoint access policies.

properties.customHostNames
  • string[]

The custom host names of the streaming endpoint

properties.description
  • string

The streaming endpoint description.

properties.freeTrialEndTime
  • string

The free trial expiration time.

properties.hostName
  • string

The streaming endpoint host name.

properties.lastModified
  • string

The exact time the streaming endpoint was last modified.

properties.maxCacheAge
  • integer

Max cache age

properties.provisioningState
  • string

The provisioning state of the streaming endpoint.

properties.resourceState

The resource state of the streaming endpoint.

properties.scaleUnits
  • integer

The number of scale units. Use the Scale operation to adjust this value.

systemData

The system metadata relating to this resource.

tags
  • object

Resource tags.

type
  • string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

StreamingEndpointAccessControl

Streaming endpoint access control definition.

Name Type Description
akamai

The access control of Akamai

ip

The IP access control of the streaming endpoint.

StreamingEndpointResourceState

The resource state of the streaming endpoint.

Name Type Description
Deleting
  • string

The streaming endpoint is being deleted.

Running
  • string

The streaming endpoint is running. It is able to stream content to clients

Scaling
  • string

The streaming endpoint is increasing or decreasing scale units.

Starting
  • string

The streaming endpoint is transitioning to the running state.

Stopped
  • string

The initial state of a streaming endpoint after creation. Content is not ready to be streamed from this endpoint.

Stopping
  • string

The streaming endpoint is transitioning to the stopped state.

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

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

The type of identity that last modified the resource.