Streaming endpoint - Get – Ravnur

In this article:

Returns the properties of a streaming endpoint. RMS supports Get and List operations for streaming endpoints; Create, Update, and Delete are not available.

GET https://{{apiEndpoint}}/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}?api-version={api-version}

AMS compatibility note

RMS accepts a small set of AMS fields to keep SDK and payload compatibility. Only properties.hostName returns a meaningful value.

The remaining properties.* fields are either accepted for AMS compatibility but not applied in RMS (marked [No-op in RMS]), or server-populated and read-only.

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	[No-op in RMS] The version of the API to be used with the client request. Required for compatibility; any value accepted; no effect.

Responses

Name	Type	Description
200 OK	StreamingEndpoint	The streaming endpoint properties.
Other Status Codes	ErrorResponse	The streaming error response describing why the operation failed.

Examples

List streaming endpoints

GET https://{{apiEndpoint}}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaServices/contosomedia/streamingEndpoints/default?api-version={{api-version}}

Sample response

Status code: 200

        {
            "location": "ravnur",
            "properties": {
                "scaleUnits": 0,
                "customHostNames": [],
                "hostName": "hostname-value",
                "cdnEnabled": false,
                "provisioningState": "Succeeded",
                "resourceState": "Running",
                "freeTrialEndTime": "0001-01-01T00:00:00Z",
                "created": "2024-08-06T12:26:50.3011455Z",
                "lastModified": "2024-08-06T12:26:50.3011455Z"
            },
            "systemData": {
                "createdBy": "System",
                "createdByType": "Application",
                "createdAt": "2024-08-06T12:26:50.3011455Z",
                "lastModifiedBy": "System",
                "lastModifiedByType": "Application",
                "lastModifiedAt": "2024-08-06T12:26:50.3011455Z"
            },
            "sku": {
                "name": "Standard",
                "capacity": 0
            },
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mrg-resourcegroup/providers/Microsoft.Media/mediaServices/default/streamingEndpoints/default",
            "name": "default",
            "type": "Microsoft.Media/mediaservices/streamingEndpoints"
        }

Definitions

StreamingEndpoint

Name	Type	Description
Values:
`name`	string	[No-op in RMS] Always `default`.
`location`	string	[No-op in RMS] Account-specific value returned by RMS. Does not reflect a standard Azure region name.
`sku`	object	Always `{name: "Standard", capacity: 0}`. Not configurable in RMS.
`systemData`	object	System metadata for the resource.
Properties:
`properties.hostName`	string	The delivery hostname configured in the RMS Console. Use this value to build playback URLs. By default this is your Front Door domain; reflects a custom domain if one has been configured.
`properties.freeTrialEndTime`	timestamp	Only relevant for free trial deployments. Always `0001-01-01T00:00:00Z` in RMS.
`properties.created`	timestamp	The date and time the streaming endpoint was created.
`properties.lastModified`	timestamp	[No-op in RMS] Always equals `properties.created`. Not updated in RMS.
`properties.description`	string	[No-op in RMS] Always null. Not persisted in RMS.
`properties.scaleUnits`	integer	[No-op in RMS] Always `0`. Not configurable in RMS.
`properties.availabilitySetName`	string	[No-op in RMS] Always null. Deprecated AMS field, accepted for compatibility only.
`properties.accessControl`	object	[No-op in RMS] Always null. Access control for streaming traffic is managed at the CDN and Front Door layer, not at the streaming endpoint.

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.

Related to

Search

Ravnur Knowledge Base

Streaming endpoint - Get