Skip to navigation

List Streaming Policies

Listing, Sorting and Filtering Streaming Policies

This endpoint returns the list of streaming policies in the specified project.

Sorting

The results from this endpoint can be ordered using the $orderby query parameter. Specify a list of field names, separated by commas where each one can optionally specify asc or desc.

Sorting is valid on the following fields: created, createdBy, id, name, properties/created, updated, updatedBy

Filtering

The $filter query parameter allows for streaming policies to be filtered on the basis of fields in the schema using OData query syntax. See this document for more details on the syntax used.

Filters are valid on the following fields: created, createdBy, createdByEmail, createdByName, id, name, properties/created, updated, updatedBy, updatedByEmail, updatedByName

Examples:

?$top=10 - Returns only the first 10 streaming policies from the list.

?$orderby=name desc - Sorts streaming policies by name in descending order.

?$filter=name eq 'descriptive name' - Returns streaming policies that match the provided name.

?$orderby=created desc - Sorts streaming policies by creation date in descending order.

?$filter=created ge 2021-01-01T00:00:00Z - Returns streaming policies created after January 1, 2021.

Note that the default policies will always appear in the results

RBAC Capability Required: ams.streamingpolicy.get

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

project_namestringRequired

Query parameters

$orderbystringOptional
Specifies the key by which the result collection should be ordered.
$filterstringOptional
Restricts the set of items returned.
$topstringOptional

Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n.

$skiptokenstringOptional

Specifies a start offset to support paginated results. Use @odata.nextLink in the result object to enumerate the collection - it will be present only if there's more than one page of entities.

Response

A list of streaming policies.
supplementalobject
Supplemental info
valuelist of objects
A list of streaming policies.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error