Streaming Endpoints - Update

Service:

Media Services

API Version:

2022-11-01

Update StreamingEndpoint
Updates a existing streaming endpoint.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}?api-version=2022-11-01

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	The version of the API to be used with the client request.

Request Body

Name	Required	Type	Description
location	True	string	The geo-location where the resource lives
properties.scaleUnits	True	integer	The number of scale units. Use the Scale operation to adjust this value.
properties.accessControl		StreamingEndpointAccessControl	The access control definition of the streaming endpoint.
properties.availabilitySetName		string	This feature is deprecated, do not set a value for this property.
properties.cdnEnabled		boolean	The CDN enabled flag.
properties.cdnProfile		string	The CDN profile name.
properties.cdnProvider		string	The CDN provider name.
properties.crossSiteAccessPolicies		CrossSiteAccessPolicies	The streaming endpoint access policies.
properties.customHostNames		string[]	The custom host names of the streaming endpoint
properties.description		string	The streaming endpoint description.
properties.maxCacheAge		integer	Max cache age
sku		ArmStreamingEndpointCurrentSku	The streaming endpoint sku.
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	StreamingEndpoint	OK. The request has succeeded.
202 Accepted	StreamingEndpoint	Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations.
Other Status Codes	ErrorResponse	The streaming error response describing why the operation failed.

Examples

Update a streaming endpoint

Sample request

HTTP

PATCH https://management.azure.com/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingEndpoints/myStreamingEndpoint1?api-version=2022-11-01

{
  "location": "West US",
  "tags": {
    "tag3": "value3",
    "tag5": "value5"
  },
  "properties": {
    "description": "test event 2",
    "scaleUnits": 5,
    "availabilitySetName": "availableset"
  }
}

Java

import com.azure.resourcemanager.mediaservices.models.StreamingEndpoint;
import java.util.HashMap;
import java.util.Map;

/** Samples for StreamingEndpoints Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/examples/streamingendpoint-update.json
     */
    /**
     * Sample code: Update a streaming endpoint.
     *
     * @param manager Entry point to MediaServicesManager.
     */
    public static void updateAStreamingEndpoint(com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        StreamingEndpoint resource =
            manager
                .streamingEndpoints()
                .getWithResponse(
                    "mediaresources", "slitestmedia10", "myStreamingEndpoint1", com.azure.core.util.Context.NONE)
                .getValue();
        resource
            .update()
            .withTags(mapOf("tag3", "value3", "tag5", "value5"))
            .withDescription("test event 2")
            .withScaleUnits(5)
            .withAvailabilitySetName("availableset")
            .apply();
    }

    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "name": "myStreamingEndpoint1",
  "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1",
  "type": "Microsoft.Media/mediaservices/streamingEndpoints",
  "location": "West US",
  "tags": {
    "tag3": "value3",
    "tag5": "value5"
  },
  "properties": {
    "description": "test event 2",
    "scaleUnits": 5,
    "availabilitySetName": "availableset",
    "cdnEnabled": false,
    "cdnProvider": null,
    "cdnProfile": null,
    "customHostNames": [],
    "maxCacheAge": null,
    "hostName": null,
    "freeTrialEndTime": "0001-01-01T00:00:00Z",
    "provisioningState": "Succeeded",
    "resourceState": null,
    "created": "0001-01-01T00:00:00Z",
    "lastModified": "0001-01-01T00:00:00Z"
  }
}

Status code:

202

azure-asyncoperation: https://management.azure.com/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpointoperations/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-11-01
location: https://management.azure.com/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1/operationlocations/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-11-01

{
  "name": "myStreamingEndpoint1",
  "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1",
  "type": "Microsoft.Media/mediaservices/streamingEndpoints",
  "location": "West US",
  "tags": {
    "tag3": "value3",
    "tag5": "value5"
  },
  "properties": {
    "description": "test event 2",
    "scaleUnits": 5,
    "availabilitySetName": "availableset",
    "cdnEnabled": false,
    "cdnProvider": null,
    "cdnProfile": null,
    "customHostNames": [],
    "maxCacheAge": null,
    "hostName": null,
    "freeTrialEndTime": "0001-01-01T00:00:00Z",
    "provisioningState": "Succeeded",
    "resourceState": null,
    "created": "0001-01-01T00:00:00Z",
    "lastModified": "0001-01-01T00:00:00Z"
  }
}

Definitions

Name	Description
AkamaiAccessControl	Akamai access control
AkamaiSignatureHeaderAuthenticationKey	Akamai Signature Header authentication key.
ArmStreamingEndpointCurrentSku	The streaming endpoint current sku.
createdByType	The type of identity that created the resource.
CrossSiteAccessPolicies	The client access policy.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
IPAccessControl	The IP access control.
IPRange	The IP address range in the CIDR scheme.
StreamingEndpoint	The streaming endpoint.
StreamingEndpointAccessControl	Streaming endpoint access control definition.
StreamingEndpointResourceState	The resource state of the streaming endpoint.
systemData	Metadata pertaining to creation and last modification of the resource.

AkamaiAccessControl

Akamai access control

Name	Type	Description
akamaiSignatureHeaderAuthenticationKeyList	AkamaiSignatureHeaderAuthenticationKey[]	authentication key list

AkamaiSignatureHeaderAuthenticationKey

Akamai Signature Header authentication key.

Name	Type	Description
base64Key	string	authentication key
expiration	string	The expiration time of the authentication key.
identifier	string	identifier of the key

ArmStreamingEndpointCurrentSku

The streaming endpoint current sku.

Name	Type	Description
capacity	integer	The streaming endpoint sku capacity.
name	string	The streaming endpoint sku name.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CrossSiteAccessPolicies

The client access policy.

Name	Type	Description
clientAccessPolicy	string	The content of clientaccesspolicy.xml used by Silverlight.
crossDomainPolicy	string	The content of crossdomain.xml used by Silverlight.

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.

IPAccessControl

The IP access control.

Name	Type	Description
allow	IPRange[]	The IP allow list.

IPRange

The IP address range in the CIDR scheme.

Name	Type	Description
address	string	The IP address.
name	string	The friendly name for the IP address range.
subnetPrefixLength	integer	The subnet mask prefix length (see CIDR notation).

StreamingEndpoint

The streaming endpoint.

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

StreamingEndpointAccessControl

Streaming endpoint access control definition.

Name	Type	Description
akamai	AkamaiAccessControl	The access control of Akamai
ip	IPAccessControl	The IP access control of the streaming endpoint.

StreamingEndpointResourceState

The resource state of the streaming endpoint.

Name	Type	Description
Deleting	string	The streaming endpoint is being deleted.
Running	string	The streaming endpoint is running. It is able to stream content to clients
Scaling	string	The streaming endpoint is increasing or decreasing scale units.
Starting	string	The streaming endpoint is transitioning to the running state.
Stopped	string	The initial state of a streaming endpoint after creation. Content is not ready to be streamed from this endpoint.
Stopping	string	The streaming endpoint is transitioning to the stopped state.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.