StreamingEndpoint interface

The streaming endpoint.

Extends

Properties

accessControl

The access control definition of the streaming endpoint.

availabilitySetName

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

cdnEnabled

The CDN enabled flag.

cdnProfile

The CDN profile name.

cdnProvider

The CDN provider name.

created

The exact time the streaming endpoint was created. NOTE: This property will not be serialized. It can only be populated by the server.

crossSiteAccessPolicies

The streaming endpoint access policies.

customHostNames

The custom host names of the streaming endpoint

description

The streaming endpoint description.

freeTrialEndTime

The free trial expiration time. NOTE: This property will not be serialized. It can only be populated by the server.

hostName

The streaming endpoint host name. NOTE: This property will not be serialized. It can only be populated by the server.

lastModified

The exact time the streaming endpoint was last modified. NOTE: This property will not be serialized. It can only be populated by the server.

maxCacheAge

Max cache age

provisioningState

The provisioning state of the streaming endpoint. NOTE: This property will not be serialized. It can only be populated by the server.

resourceState

The resource state of the streaming endpoint. NOTE: This property will not be serialized. It can only be populated by the server.

scaleUnits

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

sku

The streaming endpoint sku.

systemData

The system metadata relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

location

The geo-location where the resource lives

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

tags

Resource tags.

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

accessControl

The access control definition of the streaming endpoint.

accessControl?: StreamingEndpointAccessControl

Property Value

availabilitySetName

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

availabilitySetName?: string

Property Value

string

cdnEnabled

The CDN enabled flag.

cdnEnabled?: boolean

Property Value

boolean

cdnProfile

The CDN profile name.

cdnProfile?: string

Property Value

string

cdnProvider

The CDN provider name.

cdnProvider?: string

Property Value

string

created

The exact time the streaming endpoint was created. NOTE: This property will not be serialized. It can only be populated by the server.

created?: Date

Property Value

Date

crossSiteAccessPolicies

The streaming endpoint access policies.

crossSiteAccessPolicies?: CrossSiteAccessPolicies

Property Value

customHostNames

The custom host names of the streaming endpoint

customHostNames?: string[]

Property Value

string[]

description

The streaming endpoint description.

description?: string

Property Value

string

freeTrialEndTime

The free trial expiration time. NOTE: This property will not be serialized. It can only be populated by the server.

freeTrialEndTime?: Date

Property Value

Date

hostName

The streaming endpoint host name. NOTE: This property will not be serialized. It can only be populated by the server.

hostName?: string

Property Value

string

lastModified

The exact time the streaming endpoint was last modified. NOTE: This property will not be serialized. It can only be populated by the server.

lastModified?: Date

Property Value

Date

maxCacheAge

Max cache age

maxCacheAge?: number

Property Value

number

provisioningState

The provisioning state of the streaming endpoint. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

resourceState

The resource state of the streaming endpoint. NOTE: This property will not be serialized. It can only be populated by the server.

resourceState?: string

Property Value

string

scaleUnits

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

scaleUnits?: number

Property Value

number

sku

The streaming endpoint sku.

sku?: ArmStreamingEndpointCurrentSku

Property Value

systemData

The system metadata relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type