streaming_endpoints

Creates, updates, deletes, gets or lists a streaming_endpoints resource.

Overview

Name	streaming_endpoints
Type	Resource
Id	azure_extras.media.streaming_endpoints

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
accessControl	object	The access control definition of the streaming endpoint.
availabilitySetName	string	This feature is deprecated, do not set a value for this property.
cdnEnabled	boolean	The CDN enabled flag.
cdnProfile	string	The CDN profile name.
cdnProvider	string	The CDN provider name.
created	string (date-time)	The exact time the streaming endpoint was created.
crossSiteAccessPolicies	object	The streaming endpoint access policies.
customHostNames	array	The custom host names of the streaming endpoint.
description	string	The streaming endpoint description.
freeTrialEndTime	string (date-time)	The free trial expiration time.
hostName	string	The streaming endpoint host name.
lastModified	string (date-time)	The exact time the streaming endpoint was last modified.
location	string	The geo-location where the resource lives. Required.
maxCacheAge	integer	Max cache age.
provisioningState	string	The provisioning state of the streaming endpoint.
resourceState	string	The resource state of the streaming endpoint. Known values are: "Stopped", "Starting", "Running", "Stopping", "Deleting", and "Scaling".
scaleUnits	integer	The number of scale units. Use the Scale operation to adjust this value.
sku	object	The streaming endpoint sku.
systemData	object	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".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
accessControl	object	The access control definition of the streaming endpoint.
availabilitySetName	string	This feature is deprecated, do not set a value for this property.
cdnEnabled	boolean	The CDN enabled flag.
cdnProfile	string	The CDN profile name.
cdnProvider	string	The CDN provider name.
created	string (date-time)	The exact time the streaming endpoint was created.
crossSiteAccessPolicies	object	The streaming endpoint access policies.
customHostNames	array	The custom host names of the streaming endpoint.
description	string	The streaming endpoint description.
freeTrialEndTime	string (date-time)	The free trial expiration time.
hostName	string	The streaming endpoint host name.
lastModified	string (date-time)	The exact time the streaming endpoint was last modified.
location	string	The geo-location where the resource lives. Required.
maxCacheAge	integer	Max cache age.
provisioningState	string	The provisioning state of the streaming endpoint.
resourceState	string	The resource state of the streaming endpoint. Known values are: "Stopped", "Starting", "Running", "Stopping", "Deleting", and "Scaling".
scaleUnits	integer	The number of scale units. Use the Scale operation to adjust this value.
sku	object	The streaming endpoint sku.
systemData	object	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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, streaming_endpoint_name, subscription_id		Get StreamingEndpoint. Gets a streaming endpoint.
list	select	resource_group_name, account_name, subscription_id		List StreamingEndpoints. Lists the streaming endpoints in the account.
create	insert	resource_group_name, account_name, streaming_endpoint_name, subscription_id, location	autoStart	Create StreamingEndpoint. Creates a streaming endpoint.
update	update	resource_group_name, account_name, streaming_endpoint_name, subscription_id, location		Update StreamingEndpoint. Updates a existing streaming endpoint.
delete	delete	resource_group_name, account_name, streaming_endpoint_name, subscription_id		Delete StreamingEndpoint. Deletes a streaming endpoint.
skus	exec	resource_group_name, account_name, streaming_endpoint_name, subscription_id		List StreamingEndpoint skus. List streaming endpoint supported skus.
start	exec	resource_group_name, account_name, streaming_endpoint_name, subscription_id		Start StreamingEndpoint. Starts an existing streaming endpoint.
stop	exec	resource_group_name, account_name, streaming_endpoint_name, subscription_id		Stop StreamingEndpoint. Stops an existing streaming endpoint.
scale	exec	resource_group_name, account_name, streaming_endpoint_name, subscription_id		Scale StreamingEndpoint. Scales an existing streaming endpoint.
async_operation	exec	resource_group_name, account_name, operation_id, subscription_id		Get operation status. Get a streaming endpoint operation status.
operation_location	exec	resource_group_name, account_name, streaming_endpoint_name, operation_id, subscription_id		Get operation status. Get a streaming endpoint operation status.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_name	string	The Media Services account name. Required.
operation_id	string	The ID of an ongoing async operation. Required.
resource_group_name	string	The name of the resource group within the Azure subscription. Required.
streaming_endpoint_name	string	The name of the streaming endpoint, maximum length is 24. Required.
subscription_id	string
autoStart	boolean	The flag indicates if the resource should be automatically started on creation. Default value is None.

SELECT examples

get

Get StreamingEndpoint. Gets a streaming endpoint.

SELECT
id,
name,
accessControl,
availabilitySetName,
cdnEnabled,
cdnProfile,
cdnProvider,
created,
crossSiteAccessPolicies,
customHostNames,
description,
freeTrialEndTime,
hostName,
lastModified,
location,
maxCacheAge,
provisioningState,
resourceState,
scaleUnits,
sku,
systemData,
tags,
type
FROM azure_extras.media.streaming_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND streaming_endpoint_name = '{{ streaming_endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List StreamingEndpoints. Lists the streaming endpoints in the account.

SELECT
id,
name,
accessControl,
availabilitySetName,
cdnEnabled,
cdnProfile,
cdnProvider,
created,
crossSiteAccessPolicies,
customHostNames,
description,
freeTrialEndTime,
hostName,
lastModified,
location,
maxCacheAge,
provisioningState,
resourceState,
scaleUnits,
sku,
systemData,
tags,
type
FROM azure_extras.media.streaming_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create StreamingEndpoint. Creates a streaming endpoint.

INSERT INTO azure_extras.media.streaming_endpoints (
tags,
location,
sku,
properties,
resource_group_name,
account_name,
streaming_endpoint_name,
subscription_id,
autoStart
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ sku }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ streaming_endpoint_name }}',
'{{ subscription_id }}',
'{{ autoStart }}'
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: streaming_endpoints
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the streaming_endpoints resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the streaming_endpoints resource.
  - name: streaming_endpoint_name
    value: "{{ streaming_endpoint_name }}"
    description: Required parameter for the streaming_endpoints resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the streaming_endpoints resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: sku
    description: |
      The streaming endpoint sku.
    value:
      name: "{{ name }}"
      capacity: {{ capacity }}
  - name: properties
    value:
      description: "{{ description }}"
      scaleUnits: {{ scaleUnits }}
      availabilitySetName: "{{ availabilitySetName }}"
      accessControl:
        akamai:
          akamaiSignatureHeaderAuthenticationKeyList:
            - identifier: "{{ identifier }}"
              base64Key: "{{ base64Key }}"
              expiration: "{{ expiration }}"
        ip:
          allow:
            - name: "{{ name }}"
              address: "{{ address }}"
              subnetPrefixLength: {{ subnetPrefixLength }}
      maxCacheAge: {{ maxCacheAge }}
      customHostNames:
        - "{{ customHostNames }}"
      cdnEnabled: {{ cdnEnabled }}
      cdnProvider: "{{ cdnProvider }}"
      cdnProfile: "{{ cdnProfile }}"
      crossSiteAccessPolicies:
        clientAccessPolicy: "{{ clientAccessPolicy }}"
        crossDomainPolicy: "{{ crossDomainPolicy }}"
  - name: autoStart
    value: {{ autoStart }}
    description: The flag indicates if the resource should be automatically started on creation. Default value is None.
    description: The flag indicates if the resource should be automatically started on creation. Default value is None.

UPDATE examples

update

Update StreamingEndpoint. Updates a existing streaming endpoint.

UPDATE azure_extras.media.streaming_endpoints
SET 
tags = '{{ tags }}',
location = '{{ location }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND streaming_endpoint_name = '{{ streaming_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Delete StreamingEndpoint. Deletes a streaming endpoint.

DELETE FROM azure_extras.media.streaming_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND streaming_endpoint_name = '{{ streaming_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

skus

List StreamingEndpoint skus. List streaming endpoint supported skus.

EXEC azure_extras.media.streaming_endpoints.skus 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@streaming_endpoint_name='{{ streaming_endpoint_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

start

Start StreamingEndpoint. Starts an existing streaming endpoint.

EXEC azure_extras.media.streaming_endpoints.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@streaming_endpoint_name='{{ streaming_endpoint_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

stop

Stop StreamingEndpoint. Stops an existing streaming endpoint.

EXEC azure_extras.media.streaming_endpoints.stop 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@streaming_endpoint_name='{{ streaming_endpoint_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

scale

Scale StreamingEndpoint. Scales an existing streaming endpoint.

EXEC azure_extras.media.streaming_endpoints.scale 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@streaming_endpoint_name='{{ streaming_endpoint_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"scaleUnit": {{ scaleUnit }}
}'
;

async_operation

Get operation status. Get a streaming endpoint operation status.

EXEC azure_extras.media.streaming_endpoints.async_operation 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@operation_id='{{ operation_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

operation_location

Get operation status. Get a streaming endpoint operation status.

EXEC azure_extras.media.streaming_endpoints.operation_location 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@streaming_endpoint_name='{{ streaming_endpoint_name }}' --required, 
@operation_id='{{ operation_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;