Streaming Endpoints - Create

參考

Service:: Media Services

API Version:: 2022-11-01

建立 StreamingEndpoint
建立串流端點。

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

With optional parameters:

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

URI 參數

名稱	位於	必要	類型	Description
accountName	path	True	string	媒體服務帳戶名稱。
resourceGroupName	path	True	string	Azure 訂用帳戶內的資源組名。
streamingEndpointName	path	True	string	串流端點的名稱，最大長度為 24。 Regex pattern: `^[a-zA-Z0-9]+(-[a-zA-Z0-9])$`
subscriptionId	path	True	string	Microsoft Azure 訂用帳戶的唯一標識符。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。
autoStart	query		boolean	旗標會指出資源是否應該在建立時自動啟動。

要求本文

名稱	必要	類型	Description
location	True	string	資源所在的地理位置
properties.scaleUnits	True	integer	縮放單位數目。使用 Scale 作業來調整此值。
properties.accessControl		StreamingEndpointAccessControl	串流端點的訪問控制定義。
properties.availabilitySetName		string	這項功能已被取代，請勿設定此屬性的值。
properties.cdnEnabled		boolean	已啟用CDN的旗標。
properties.cdnProfile		string	CDN 設定檔名稱。
properties.cdnProvider		string	CDN 提供者名稱。
properties.crossSiteAccessPolicies		CrossSiteAccessPolicies	串流端點存取原則。
properties.customHostNames		string[]	串流端點的自定義主機名
properties.description		string	串流端點描述。
properties.maxCacheAge		integer	快取存留期上限
sku		ArmStreamingEndpointCurrentSku	串流端點 SKU。
tags		object	資源標籤。

回應

名稱	類型	Description
200 OK	StreamingEndpoint	正常。要求成功。
201 Created	StreamingEndpoint	已建立。已接受處理要求，且作業將會以異步方式完成。如需使用 Azure-AsyncOperation 回應標頭監視異步 Azure 作業的詳細資訊，請參閱 https://go.microsoft.com/fwlink/?linkid=2087017 。
Other Status Codes	ErrorResponse	串流錯誤回應，描述作業失敗的原因。

範例

Create a streaming endpoint

PUT 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": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "description": "test event 1",
    "scaleUnits": 1,
    "availabilitySetName": "availableset",
    "accessControl": {
      "akamai": {
        "akamaiSignatureHeaderAuthenticationKeyList": [
          {
            "identifier": "id1",
            "expiration": "2029-12-31T16:00:00-08:00",
            "base64Key": "dGVzdGlkMQ=="
          },
          {
            "identifier": "id2",
            "expiration": "2030-12-31T16:00:00-08:00",
            "base64Key": "dGVzdGlkMQ=="
          }
        ]
      },
      "ip": {
        "allow": [
          {
            "name": "AllowedIp",
            "address": "192.168.1.1"
          }
        ]
      }
    },
    "cdnEnabled": false
  }
}

import com.azure.resourcemanager.mediaservices.models.AkamaiAccessControl;
import com.azure.resourcemanager.mediaservices.models.AkamaiSignatureHeaderAuthenticationKey;
import com.azure.resourcemanager.mediaservices.models.IpAccessControl;
import com.azure.resourcemanager.mediaservices.models.IpRange;
import com.azure.resourcemanager.mediaservices.models.StreamingEndpointAccessControl;
import java.time.OffsetDateTime;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/** Samples for StreamingEndpoints Create. */
public final class Main {
    /*
     * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/examples/streamingendpoint-create.json
     */
    /**
     * Sample code: Create a streaming endpoint.
     *
     * @param manager Entry point to MediaServicesManager.
     */
    public static void createAStreamingEndpoint(com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager
            .streamingEndpoints()
            .define("myStreamingEndpoint1")
            .withRegion("West US")
            .withExistingMediaservice("mediaresources", "slitestmedia10")
            .withTags(mapOf("tag1", "value1", "tag2", "value2"))
            .withDescription("test event 1")
            .withScaleUnits(1)
            .withAvailabilitySetName("availableset")
            .withAccessControl(
                new StreamingEndpointAccessControl()
                    .withAkamai(
                        new AkamaiAccessControl()
                            .withAkamaiSignatureHeaderAuthenticationKeyList(
                                Arrays
                                    .asList(
                                        new AkamaiSignatureHeaderAuthenticationKey()
                                            .withIdentifier("id1")
                                            .withBase64Key("fakeTokenPlaceholder")
                                            .withExpiration(OffsetDateTime.parse("2029-12-31T16:00:00-08:00")),
                                        new AkamaiSignatureHeaderAuthenticationKey()
                                            .withIdentifier("id2")
                                            .withBase64Key("fakeTokenPlaceholder")
                                            .withExpiration(OffsetDateTime.parse("2030-12-31T16:00:00-08:00")))))
                    .withIp(
                        new IpAccessControl()
                            .withAllow(Arrays.asList(new IpRange().withName("AllowedIp").withAddress("192.168.1.1")))))
            .withCdnEnabled(false)
            .create();
    }

    @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:: 201

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

Response Body

{
  "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": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "description": "test event 1",
    "scaleUnits": 1,
    "availabilitySetName": "availableset",
    "cdnEnabled": false,
    "cdnProvider": null,
    "cdnProfile": "",
    "customHostNames": [],
    "accessControl": {
      "akamai": {
        "akamaiSignatureHeaderAuthenticationKeyList": [
          {
            "identifier": "id1",
            "expiration": "2030-01-01T00:00:00Z",
            "base64Key": "dGVzdGlkMQ=="
          },
          {
            "identifier": "id2",
            "expiration": "2031-01-01T00:00:00Z",
            "base64Key": "dGVzdGlkMQ=="
          }
        ]
      },
      "ip": {
        "allow": [
          {
            "name": "AllowedIp",
            "address": "192.168.1.1",
            "subnetPrefixLength": null
          }
        ]
      }
    },
    "maxCacheAge": null,
    "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net",
    "freeTrialEndTime": "0001-01-01T00:00:00-08:00",
    "provisioningState": "InProgress",
    "resourceState": "Creating",
    "created": "2018-03-03T02:25:09.7561389Z",
    "lastModified": "2018-03-03T02:25:09.7561389Z"
  }
}

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": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "description": "test event 1",
    "scaleUnits": 1,
    "availabilitySetName": "availableset",
    "cdnEnabled": false,
    "cdnProvider": null,
    "cdnProfile": "",
    "customHostNames": [],
    "accessControl": {
      "akamai": {
        "akamaiSignatureHeaderAuthenticationKeyList": [
          {
            "identifier": "id1",
            "expiration": "2030-01-01T00:00:00Z",
            "base64Key": "dGVzdGlkMQ=="
          },
          {
            "identifier": "id2",
            "expiration": "2031-01-01T00:00:00Z",
            "base64Key": "dGVzdGlkMQ=="
          }
        ]
      },
      "ip": {
        "allow": [
          {
            "name": "AllowedIp",
            "address": "192.168.1.1",
            "subnetPrefixLength": null
          }
        ]
      }
    },
    "maxCacheAge": null,
    "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net",
    "freeTrialEndTime": "0001-01-01T00:00:00-08:00",
    "provisioningState": "Succeeded",
    "resourceState": "Stopped",
    "created": "2018-03-03T02:25:09.7561389Z",
    "lastModified": "2018-03-03T02:25:09.7561389Z"
  }
}

定義

名稱	Description
AkamaiAccessControl	Akamai 訪問控制
AkamaiSignatureHeaderAuthenticationKey	Akamai 簽章標頭驗證密鑰。
ArmStreamingEndpointCurrentSku	串流端點目前的 SKU。
createdByType	建立資源的身分識別類型。
CrossSiteAccessPolicies	用戶端存取原則。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
IPAccessControl	IP 存取控制。
IPRange	CIDR 配置中的IP位址範圍。
StreamingEndpoint	串流端點。
StreamingEndpointAccessControl	串流端點訪問控制定義。
StreamingEndpointResourceState	串流端點的資源狀態。
systemData	與建立和上次修改資源相關的元數據。

AkamaiAccessControl

Akamai 訪問控制

名稱	類型	Description
akamaiSignatureHeaderAuthenticationKeyList	AkamaiSignatureHeaderAuthenticationKey[]	驗證金鑰清單

AkamaiSignatureHeaderAuthenticationKey

Akamai 簽章標頭驗證密鑰。

名稱	類型	Description
base64Key	string	驗證金鑰
expiration	string	驗證金鑰的到期時間。
identifier	string	金鑰的識別碼

ArmStreamingEndpointCurrentSku

串流端點目前的 SKU。

名稱	類型	Description
capacity	integer	串流端點 SKU 容量。
name	string	串流端點 SKU 名稱。

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CrossSiteAccessPolicies

用戶端存取原則。

名稱	類型	Description
clientAccessPolicy	string	Silverlight 所使用的 clientaccesspolicy.xml 內容。
crossDomainPolicy	string	Silverlight 所使用的 crossdomain.xml 內容。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

IPAccessControl

IP 存取控制。

名稱	類型	Description
allow	IPRange[]	IP 允許清單。

IPRange

CIDR 配置中的IP位址範圍。

名稱	類型	Description
address	string	IP 位址。
name	string	IP 位址範圍的易記名稱。
subnetPrefixLength	integer	子網掩碼前置詞長度 (請參閱 CIDR 表示法) 。

StreamingEndpoint

串流端點。

名稱	類型	Description
id	string	資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	資源所在的地理位置
name	string	資源的名稱
properties.accessControl	StreamingEndpointAccessControl	串流端點的訪問控制定義。
properties.availabilitySetName	string	這項功能已被取代，請勿設定此屬性的值。
properties.cdnEnabled	boolean	已啟用CDN的旗標。
properties.cdnProfile	string	CDN 設定檔名稱。
properties.cdnProvider	string	CDN 提供者名稱。
properties.created	string	建立串流端點的確切時間。
properties.crossSiteAccessPolicies	CrossSiteAccessPolicies	串流端點存取原則。
properties.customHostNames	string[]	串流端點的自定義主機名
properties.description	string	串流端點描述。
properties.freeTrialEndTime	string	免費試用到期時間。
properties.hostName	string	串流端點主機名。
properties.lastModified	string	上次修改串流端點的確切時間。
properties.maxCacheAge	integer	快取存留期上限
properties.provisioningState	string	串流端點的布建狀態。
properties.resourceState	StreamingEndpointResourceState	串流端點的資源狀態。
properties.scaleUnits	integer	縮放單位數目。使用 Scale 作業來調整此值。
sku	ArmStreamingEndpointCurrentSku	串流端點 SKU。
systemData	systemData	與此資源相關的系統元數據。
tags	object	資源標籤。
type	string	資源類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

StreamingEndpointAccessControl

串流端點訪問控制定義。

名稱	類型	Description
akamai	AkamaiAccessControl	Akamai 的訪問控制
ip	IPAccessControl	串流端點的IP訪問控制。

StreamingEndpointResourceState

串流端點的資源狀態。

名稱	類型	Description
Deleting	string	正在刪除串流端點。
Running	string	串流端點正在執行。它可以將內容串流至用戶端
Scaling	string	串流端點正在增加或減少縮放單位。
Starting	string	串流端點正在轉換為執行中狀態。
Stopped	string	串流端點建立之後的初始狀態。內容尚未準備好從此端點進行串流處理。
Stopping	string	串流端點正在轉換為已停止狀態。

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳 (UTC) 。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳 (UTC)
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。