Live Outputs - Create

參考

服務:: Media Services

API 版本:: 2022-11-01

建立實時輸出
建立新的實時輸出。

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

URI 參數

名稱	位於	必要	類型	Description
accountName	path	True	string	媒體服務帳戶名稱。
liveEventName	path	True	string	實時活動的名稱，最大長度為32。 Regex 模式: `^[a-zA-Z0-9]+(-[a-zA-Z0-9])$`
liveOutputName	path	True	string	實時輸出的名稱。 Regex 模式: `^([a-zA-Z0-9])+(-[a-zA-Z0-9])$`
resourceGroupName	path	True	string	Azure 訂用帳戶內的資源組名。
subscriptionId	path	True	string	Microsoft Azure 訂用帳戶的唯一標識符。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。

要求本文

名稱	必要	類型	Description
properties.archiveWindowLength	True	string	ISO 8601 時間介於 1 分鐘到 25 小時之間，表示此即時輸出資產中可封存的內容長度上限。這也會設定倒轉視窗的內容長度上限。例如，使用 PT1H30M 來指出封存視窗的 1 小時和 30 分鐘。
properties.assetName	True	string	實時輸出將寫入的資產。
properties.description		string	實時輸出的描述。
properties.hls		Hls	HTTP 即時串流 (實時輸出的 HLS) 封裝設定。
properties.manifestName		string	指令清單檔名。如果未提供，服務將會自動產生一個。
properties.outputSnapTime		integer	實時輸出開始的初始時間戳，此值之前的任何內容都不會封存。
properties.rewindWindowLength		string	ISO 8601 時間介於封存期間 1 分鐘到 archiveWindowLength 的持續時間，以控制即時期間可搜尋的視窗長度。一旦 LiveOutput 停止，服務就不會使用此屬性。封存的 VOD 將會有原始 ArchiveWindowLength 的完整內容。例如，使用 PT1H30M 表示 1 小時和 30 分鐘的倒轉視窗長度。只有在即時活動啟用 LL 時，服務才會使用隱含預設值 30m。

回應

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

範例

Create a LiveOutput

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

{
  "properties": {
    "description": "test live output 1",
    "assetName": "6f3264f5-a189-48b4-a29a-a40f22575212",
    "archiveWindowLength": "PT5M",
    "rewindWindowLength": "PT4M",
    "manifestName": "testmanifest",
    "hls": {
      "fragmentsPerTsSegment": 5
    }
  }
}


import com.azure.resourcemanager.mediaservices.models.Hls;
import java.time.Duration;

/**
 * Samples for LiveOutputs Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/examples/liveoutput-
     * create.json
     */
    /**
     * Sample code: Create a LiveOutput.
     * 
     * @param manager Entry point to MediaServicesManager.
     */
    public static void createALiveOutput(com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager.liveOutputs().define("myLiveOutput1")
            .withExistingLiveEvent("mediaresources", "slitestmedia10", "myLiveEvent1")
            .withDescription("test live output 1").withAssetName("6f3264f5-a189-48b4-a29a-a40f22575212")
            .withArchiveWindowLength(Duration.parse("PT5M")).withRewindWindowLength(Duration.parse("PT4M"))
            .withManifestName("testmanifest").withHls(new Hls().withFragmentsPerTsSegment(5)).create();
    }
}

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

範例回覆

狀態碼:: 200

{
  "name": "myLiveOutput1",
  "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/myLiveOutput1",
  "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs",
  "properties": {
    "description": "test live output 1",
    "assetName": "6f3264f5-a189-48b4-a29a-a40f22575212",
    "archiveWindowLength": "PT5M",
    "manifestName": "testmanifest",
    "outputSnapTime": 0,
    "resourceState": "Stopped",
    "provisioningState": "Succeeded",
    "created": "2018-03-03T02:25:09.9431835Z",
    "lastModified": "2018-03-03T02:25:09.9431835Z",
    "hls": {
      "fragmentsPerTsSegment": 5
    },
    "rewindWindowLength": "PT4M"
  },
  "systemData": {
    "createdBy": "example@microsoft.com",
    "createdByType": "User",
    "createdAt": "2018-03-03T02:25:09.9431835Z",
    "lastModifiedBy": "example@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2018-03-03T02:25:09.9431835Z"
  }
}

狀態碼:: 201

{
  "name": "myLiveOutput1",
  "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/myLiveOutput1",
  "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs",
  "properties": {
    "description": "test live output 1",
    "assetName": "6f3264f5-a189-48b4-a29a-a40f22575212",
    "archiveWindowLength": "PT5M",
    "manifestName": "testmanifest",
    "outputSnapTime": 0,
    "resourceState": "Creating",
    "provisioningState": "InProgress",
    "created": "2018-03-03T02:25:09.9431835Z",
    "lastModified": "2018-03-03T02:25:09.9431835Z",
    "hls": {
      "fragmentsPerTsSegment": 5
    },
    "rewindWindowLength": "PT4M"
  },
  "systemData": {
    "createdBy": "example@microsoft.com",
    "createdByType": "User",
    "createdAt": "2018-03-03T02:25:09.9431835Z",
    "lastModifiedBy": "example@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2018-03-03T02:25:09.9431835Z"
  }
}

定義

名稱	Description
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
Hls	HTTP 即時串流 (實時輸出的 HLS) 封裝設定。
LiveOutput	實時輸出。
LiveOutputResourceState	實時輸出的資源狀態。
systemData	與建立和上次修改資源相關的元數據。

createdByType

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

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

ErrorAdditionalInfo

資源管理錯誤其他資訊。

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

ErrorDetail

錯誤詳細數據。

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

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

Hls

HTTP 即時串流 (實時輸出的 HLS) 封裝設定。

名稱	類型	Description
fragmentsPerTsSegment	integer	即時活動輸出中 HTTP 即時串流 (HLS) TS 區段中的片段數目。此值不會影響 HLS CMAF 輸出的封裝比例。

LiveOutput

實時輸出。

名稱	類型	Description
id	string	資源的完整資源識別碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties.archiveWindowLength	string	ISO 8601 時間介於 1 分鐘到 25 小時之間，表示此即時輸出資產中可封存的內容長度上限。這也會設定倒轉視窗的內容長度上限。例如，使用 PT1H30M 來指出封存視窗的 1 小時和 30 分鐘。
properties.assetName	string	實時輸出將寫入的資產。
properties.created	string	實時輸出的建立時間。
properties.description	string	實時輸出的描述。
properties.hls	Hls	HTTP 即時串流 (實時輸出的 HLS) 封裝設定。
properties.lastModified	string	上次修改即時輸出的時間。
properties.manifestName	string	指令清單檔名。如果未提供，服務將會自動產生一個。
properties.outputSnapTime	integer	實時輸出開始的初始時間戳，此值之前的任何內容都不會封存。
properties.provisioningState	string	實時輸出的布建狀態。
properties.resourceState	LiveOutputResourceState	實時輸出的資源狀態。
properties.rewindWindowLength	string	ISO 8601 時間介於封存期間 1 分鐘到 archiveWindowLength 的持續時間，以控制即時期間可搜尋的視窗長度。一旦 LiveOutput 停止，服務就不會使用此屬性。封存的 VOD 將會有原始 ArchiveWindowLength 的完整內容。例如，使用 PT1H30M 表示 1 小時和 30 分鐘的倒轉視窗長度。只有在即時活動啟用 LL 時，服務才會使用隱含預設值 30m。
systemData	systemData	與此資源相關的系統元數據。
type	string	資源類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

LiveOutputResourceState

實時輸出的資源狀態。

名稱	類型	Description
Creating	string	正在建立實時輸出。在即時輸出處於執行狀態之前，資產中不會封存任何內容。
Deleting	string	正在刪除實時輸出。實時資產會從即時資產轉換為隨選資產。在即時輸出資產上建立的任何串流 URL 都會繼續運作。
Running	string	如果參與編碼器有有效的輸入，實時輸出會執行並將即時串流內容封存到資產。

systemData

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

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

共用方式為