StreamingEndpointListResponseSchema

object

@odata.nextLink string Optional

@odata.nextLink URL if the page length and number of items match.

supplemental object ListResponseSupplementalSchema Required

Supplemental info

Show 5 properties Hide 5 properties

count integer Required

Number of items returned

kind string Required

Type of items in the list

operation string Required

Operation type. Should always say 'list'

pagination object PaginationInfoSchema Required

Pagination info

Show 4 properties Hide 4 properties

end integer Required

Position of the last item in the list

records integer Required

Total number of items returned in the list

start integer Required

Position of the first item in the list

total integer Required

Total number of items in the project

subscription object ProjectInfoSchema Optional

Project info

Show 2 properties Hide 2 properties

id string Required

Project ID

name string Required

Project name

value list of objects StreamingEndpointSchema Required

A list of streaming endpoints

Show 4 properties Hide 4 properties

location string Required

The name of the location in which the streaming endpoint is located. This field must match the location in which the user's subscription is provisioned.

name string Optional 1-64 characters pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$

The name of the resource

properties object StreamingEndpointProperties Required

The properties of the streaming endpoint.

Show 21 properties Hide 21 properties

accessControl object StreamingEndpointAccessControl Optional

The access control settings for the streaming endpoint.

Show 2 properties Hide 2 properties

akamai object StreamingEndpointAkamiACL Optional Deprecated

DEPRECATED: This is provided for backwards compatibility and will be removed in a future release. Akamai access control configuration for the streaming endpoint. If the Akamai CDN profile is specified and CDN is enabled, this field is required.

Show 1 property Hide 1 property

akamaiSignatureHeaderAuthenticationKeyList list of objects AkamiHeaderAuthKey Required Deprecated

DEPRECATED: This is provided for backwards compatibility and will be removed in a future release. The Akamai access control configuration for the streaming endpoint. Learn more: https://techdocs.akamai.com/netstorage-usage/reference/example-authentication-headers

Show 3 properties Hide 3 properties

base64Key string Optional

expiration string Optional

identifier string Optional

ip object StreamingEndpointIPACL Optional

IP-based access control configuration for the streaming endpoint. If omitted, this will default to 0.0.0.0/0

Show 1 property Hide 1 property

allow list of objects IPAcl Required

The IP allow list.

Show 3 properties Hide 3 properties

address string Required

name string Optional Defaults to

The name of the IP ACL.

subnetPrefixLength integer Optional 0 to 32 Defaults to 32

The subnet prefix length (see CIDR notation).

advancedSettingsName string or null Optional <=64 characters

Name of the advanced settings configuration to apply to this streaming endpoint. These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.

cdnBasePath string Optional

If CDN is enabled, the path that must be inserted after the hostname and before the locator, e.g. https://.

cdnEnabled boolean Optional Defaults to false

Indicates if CDN is enabled for the streaming endpoint.

cdnProfile string Optional <=100 characters

If CDN is enabled, the optional CDN profile name for the streaming endpoint.

cdnProvider enum Optional Deprecated

DEPRECATED: CDN provider is set by default when CDN is enabled. Value will be ignored if provided. This is provided for backwards compatibility and will be removed in a future release.

Allowed values: Standard Akamai

created string Optional format: date-time

The creation date and time of the streaming endpoint. Set by the system.

crossSiteAccessPolicies object CrossSiteAccessPolicies Optional

Cross-site access policies are CDN policies for Smooth or DASH streaming that determine which domains clients are permitted to playback content from.

Show 2 properties Hide 2 properties

clientAccessPolicy string or null Optional

The XML content of the client access policy file. Search 'clientaccesspolicy.xml' to learn more.

crossDomainPolicy string or null Optional

The XML content of the cross-domain policy file. Search 'crossdomain.xml' to learn more.

customHostNames list of strings Optional

NOT SUPPORTED pending implementation of DNS validation. Custom host names for the streaming endpoint. Must be unique within the region. If not specified, a default hostname will be used. The best practice for custom DNS is to use a CNAME pointing to the autogenerated hostname derived from the streaming endpoint name, and to configure your CDN to deliver a HOST header to the origin server for routing purposes.

description string or null Optional <=1024 characters

The description of the streaming endpoint.

hostName string Optional

The fqdn of the streaming endpoint. This is the output hostname and is always configured. To set a custom hostname, use the customHostNames property.

lastModified string Optional format: date-time

The last modified date and time of the streaming endpoint. Set by the system.

maxCacheAge integer Optional 0 to 2592000 Defaults to 86400

The maximum amount of time that segments will be cached, in seconds. This value is superseded by any ETAG values set by the infrastructure.

maxManifestCacheAge integer Optional 0 to 2592000 Defaults to 60

The maximum amount of time that closed manifests will be cached, in seconds. This value is superseded by any ETAG values set by the infrastructure.

provisioningState enum Optional

The provisioning state of the streaming endpoint. Set by the system. One of InProgress, Succeeded, Failed.

Allowed values: InProgress Succeeded Failed

publicName string Optional 3-63 characters pattern: ^[a-z0-9]+(-[a-z0-9]+)*$

Public name for the streaming endpoint

resourceState enum Optional

The runtime state of the streaming endpoint. Set by the system.

Allowed values: Creating Updating Scaling Starting Stopping Restarting Deleting Running Stopped Deleted

scaleUnits integer Required >=0

The number of scale units for the streaming endpoint. This will determine your minimum scale. A value of 0 will result in the streaming endpoints using a Standard SKU. A value greater than zero indicates that the 'Premium' SKUs will be provisioned.

shieldCache object StreamingEndpointShieldCache Optional

Shield cache configuration for the streaming endpoint.

Show 1 property Hide 1 property

scaleUnits integer or null Required 0 to 1024

The number of scale units for the shield cache. A value of 0 indicates that no shield cache will be deployed. This feature should only be used if advised by MediaKind. It is controlled by a feature flag.

sku object StreamingEndpointsCurrentSku Optional

The SKU definition for the streaming endpoint.

Show 2 properties Hide 2 properties

capacity integer Optional

This is the bandwidth capacity of current streaming unit configuration

name enum Required

The name of the SKU. Will default to 'Standard' if the sku configuration is not provided.

Allowed values: Standard Premium

urlStyle string Optional

The style of URL associated with the streaming endpoint. The default is 'AMS' and you should only use any other value if advised to by MediaKind

tags map from strings to string Optional

A dictionary of key:value pairs describing the resource. Search may be implemented against tags in the future.

Show value schema Hide value schema

[any key] string