Live Events - Operation Location

參考

服務:: Media Services

API 版本:: 2022-11-01

取得作業狀態。
取得即時事件作業狀態。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/operationLocations/{operationId}?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])$`
operationId	path	True	string	進行中異步操作的標識碼。
resourceGroupName	path	True	string	Azure 訂用帳戶內的資源組名。
subscriptionId	path	True	string	Microsoft Azure 訂用帳戶的唯一標識符。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。

回應

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

範例

Get the LiveEvent operation status

GET https://management.azure.com/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveEvents/myLiveEvent1/operationLocations/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-11-01


/**
 * Samples for LiveEvents OperationLocation.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/mediaservices/resource-manager/Microsoft.Media/Streaming/stable/2022-11-01/examples/liveevent-
     * operation-location.json
     */
    /**
     * Sample code: Get the LiveEvent operation status.
     * 
     * @param manager Entry point to MediaServicesManager.
     */
    public static void
        getTheLiveEventOperationStatus(com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager.liveEvents().operationLocationWithResponse("mediaresources", "slitestmedia10", "myLiveEvent1",
            "62e4d893-d233-4005-988e-a428d9f77076", com.azure.core.util.Context.NONE);
    }
}

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

範例回覆

狀態碼:: 202

狀態碼:: 200

{
  "name": "myLiveEvent1",
  "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1",
  "type": "Microsoft.Media/mediaservices/liveevents",
  "location": "West US",
  "tags": {},
  "properties": {
    "description": "",
    "resourceState": "Stopped",
    "provisioningState": "Succeeded",
    "created": "2018-03-03T02:25:08.3474032Z",
    "lastModified": "2018-03-03T02:25:08.3474032Z",
    "useStaticHostname": false,
    "streamOptions": [
      "Default"
    ],
    "input": {
      "keyFrameIntervalDuration": "PT6S",
      "streamingProtocol": "FragmentedMP4",
      "accessToken": null,
      "endpoints": [
        {
          "protocol": "FragmentedMP4",
          "url": "http://clouddeployment.media-test.net/ingest.isml"
        }
      ],
      "timedMetadataEndpoints": []
    },
    "preview": {
      "previewLocator": "763f3ea4-d94f-441c-a634-c833f61a4e04",
      "streamingPolicyName": null,
      "accessControl": {
        "ip": {
          "allow": [
            {
              "name": "AllowAll",
              "address": "0.0.0.0",
              "subnetPrefixLength": 0
            }
          ]
        }
      },
      "endpoints": [
        {
          "protocol": "FragmentedMP4",
          "url": "https://testeventopito4idh2r-weibzmedia05.preview-ts051.channel.media-test.windows-int.net/763f3ea4-d94f-441c-a634-c833f61a4e04/preview.ism/manifest"
        }
      ]
    },
    "encoding": {
      "encodingType": "None",
      "presetName": null
    },
    "crossSiteAccessPolicies": {
      "clientAccessPolicy": "<access-policy><cross-domain-access><policy><allow-from http-methods=\"*\"><domain uri=\"http://*\"/></allow-from><grant-to><resource path=\"/\" include-subpaths=\"true\"/></grant-to></policy></cross-domain-access></access-policy>",
      "crossDomainPolicy": "<cross-domain-policy><allow-access-from domain=\"*\" secure=\"false\" /></cross-domain-policy>"
    }
  },
  "systemData": {
    "createdBy": "example@microsoft.com",
    "createdByType": "User",
    "createdAt": "2018-03-03T02:25:08.3474032Z",
    "lastModifiedBy": "example@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2018-03-03T02:25:08.3474032Z"
  }
}

定義

名稱	Description
createdByType	建立資源的身分識別類型。
CrossSiteAccessPolicies	用戶端存取原則。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
IPAccessControl	IP 存取控制。
IPRange	CIDR 配置中的IP位址範圍。
LiveEvent	實時活動。
LiveEventEncoding	指定即時活動類型和選擇性編碼設定來編碼即時活動。
LiveEventEncodingType	即時活動類型。當 encodingType 設定為 PassthroughBasic 或 PassthroughStandard 時，服務只會透過傳入視訊和音訊層 () 傳遞至輸出。當 encodingType 設定為 Standard 或 Premium1080p 時，即時編碼器會將傳入數據流轉碼成多個比特率或圖層。如需相關資訊，請參閱 https://go.microsoft.com/fwlink/?linkid=2095101 。建立即時活動之後，就無法修改這個屬性。
LiveEventEndpoint	即時事件端點。
LiveEventInput	即時活動輸入。
LiveEventInputAccessControl	即時活動輸入的IP訪問控制。
LiveEventInputProtocol	即時事件的輸入通訊協定。這會在建立時指定，而且無法更新。
LiveEventInputTrackSelection	追蹤選取條件。此屬性保留供日後使用，將會忽略此屬性上設定的任何值。
LiveEventOutputTranscriptionTrack	描述即時活動輸出中的轉譯追蹤，其使用語音轉換文字轉譯所產生的文字記錄。此屬性保留供日後使用，將會忽略此屬性上設定的任何值。
LiveEventPreview	即時活動預覽設定。
LiveEventPreviewAccessControl	即時事件預覽端點的IP訪問控制。
LiveEventResourceState	即時活動的資源狀態。如需相關資訊，請參閱 https://go.microsoft.com/fwlink/?linkid=2139012 。
LiveEventTimedMetadataEndpoint	即時事件元數據插入端點。
LiveEventTranscription	描述即時活動的輸出中的轉譯追蹤，其使用語音轉換文字文字轉譯產生。此屬性保留供日後使用，將會忽略此屬性上設定的任何值。
StreamOptionsFlag	要用於 LiveEvent 的選項。此值會在建立時指定，而且無法更新。陣列專案值的有效值為『Default』和 'LowLatency'。
StretchMode	指定如何調整輸入視訊的大小，以符合所需的輸出解析度 () 。預設值為 None
systemData	與建立和上次修改資源相關的元數據。

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 表示法) 。

LiveEvent

實時活動。

名稱	類型	Description
id	string	資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	資源所在的地理位置
name	string	資源的名稱
properties.created	string	即時活動的建立時間
properties.crossSiteAccessPolicies	CrossSiteAccessPolicies	即時活動跨網站存取原則。
properties.description	string	即時活動的描述。
properties.encoding	LiveEventEncoding	即時活動的編碼設定。它會設定是否使用即時編碼器進行即時活動，以及使用即時編碼器的設定。
properties.hostnamePrefix	string	當 useStaticHostname 設定為 true 時，hostnamePrefix 會指定指派給即時活動預覽並內嵌端點之主機名的第一個部分。最後的主機名稱是此前置詞、媒體服務帳戶名稱和 Azure 媒體服務資料中心簡短代碼的組合。
properties.input	LiveEventInput	即時活動輸入設定。它會定義即時活動如何接收來自參與編碼器的輸入。
properties.lastModified	string	即時活動的上次修改時間。
properties.preview	LiveEventPreview	即時活動預覽設定。預覽可讓即時活動產生者預覽即時串流內容，而不需建立任何實時輸出。
properties.provisioningState	string	即時活動的布建狀態。
properties.resourceState	LiveEventResourceState	即時活動的資源狀態。如需相關資訊，請參閱 https://go.microsoft.com/fwlink/?linkid=2139012 。
properties.streamOptions	StreamOptionsFlag[]	要用於 LiveEvent 的選項。此值是在建立時指定，而且無法更新。陣列專案值的有效值為『Default』和 'LowLatency'。
properties.transcriptions	LiveEventTranscription[]	即時活動的即時轉譯設定。如需實時轉譯功能的詳細資訊，請參閱 https://go.microsoft.com/fwlink/?linkid=2133742 。
properties.useStaticHostname	boolean	指定是否將靜態主機名指派給即時活動預覽和內嵌端點。只有在即時活動處於待命狀態時，才能更新此值
systemData	systemData	與此資源相關的系統元數據。
tags	object	資源標籤。
type	string	資源類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

LiveEventEncoding

指定即時活動類型和選擇性編碼設定來編碼即時活動。

名稱	類型	Description
encodingType	LiveEventEncodingType	即時活動類型。當 encodingType 設定為 PassthroughBasic 或 PassthroughStandard 時，服務只會傳遞傳入的視訊和音訊層， (s) 至輸出。當 encodingType 設定為 Standard 或 Premium1080p 時，即時編碼器會將傳入數據流轉碼成多個比特率或圖層。如需相關資訊，請參閱 https://go.microsoft.com/fwlink/?linkid=2095101 。建立實況活動之後，就無法修改這個屬性。
keyFrameInterval	string	使用介於 0.5 到 20 秒之間的 ISO 8601 時間值，指定編碼即時活動的視訊和音訊播放軌的輸出片段長度。例如，使用 PT2S 表示 2 秒。對於視訊播放軌，也會定義主要畫面格間隔，或 GoP (圖片群組的長度) 。如果未針對編碼即時事件設定此值，則片段持續時間預設為2秒。無法設定傳遞即時活動的值。
presetName	string	選擇性編碼預設名稱，當 encodingType 不是 None 時使用。此值是在建立時指定，而且無法更新。如果 encodingType 設定為 Standard，則預設預設名稱為 'Default720p'。否則，如果 encodingType 設定為 Premium1080p，則預設預設值為 'Default1080p'。
stretchMode	StretchMode	指定輸入視訊的大小如何調整，以符合所需的輸出解析度 () 。預設值為 None

LiveEventEncodingType

即時活動類型。當 encodingType 設定為 PassthroughBasic 或 PassthroughStandard 時，服務只會透過傳入視訊和音訊層 () 傳遞至輸出。當 encodingType 設定為 Standard 或 Premium1080p 時，即時編碼器會將傳入數據流轉碼成多個比特率或圖層。如需相關資訊，請參閱 https://go.microsoft.com/fwlink/?linkid=2095101 。建立即時活動之後，就無法修改這個屬性。

名稱	類型	Description
None	string	這與 PassthroughStandard 相同，請參閱下面的描述。這個列舉值已被取代。
PassthroughBasic	string	擷取的數據流會從參與編碼器傳遞即時活動，而不需要進一步處理。在 PassthroughBasic 模式中，擷取限制為最多 5Mbps，而且只允許 1 個並行實時輸出。無法使用即時轉譯。
PassthroughStandard	string	擷取的數據流會從參與編碼器傳遞即時活動，而不需要進一步處理。即時轉譯可供使用。擷取比特率限制較高，最多允許 3 個並行實時輸出。
Premium1080p	string	參與即時編碼器會將單一比特率串流傳送至實時活動，而媒體服務會建立多個比特率串流。輸出解析度不能超過 1080p。
Standard	string	參與即時編碼器會將單一比特率串流傳送至實時活動，而媒體服務會建立多個比特率串流。輸出解析度不能超過 720p。

LiveEventEndpoint

即時事件端點。

名稱	類型	Description
protocol	string	端點通訊協定。
url	string	端點 URL。

LiveEventInput

即時活動輸入。

名稱	類型	Description
accessControl	LiveEventInputAccessControl	即時活動輸入的訪問控制。
accessToken	string	字串形式的 UUID，可唯一識別數據流。這可以在建立時指定，但無法更新。如果省略，服務將會產生唯一的值。
endpoints	LiveEventEndpoint[]	即時活動的輸入端點。
keyFrameIntervalDuration	string	輸入主要畫面格間隔持續時間的 ISO 8601 時間持續時間。這個值會在 HLS 輸出中設定 EXT-X-TARGETDURATION 屬性。例如，使用 PT2S 表示 2 秒。將值保留空白，以便編碼實時活動。
streamingProtocol	LiveEventInputProtocol	即時活動的輸入通訊協定。這會在建立時指定，而且無法更新。
timedMetadataEndpoints	LiveEventTimedMetadataEndpoint[]	即時活動的元數據端點。

LiveEventInputAccessControl

即時活動輸入的IP訪問控制。

名稱	類型	Description
ip	IPAccessControl	IP 存取控制屬性。

LiveEventInputProtocol

即時事件的輸入通訊協定。這會在建立時指定，而且無法更新。

名稱	類型	Description
FragmentedMP4	string	Smooth Streaming 輸入會由參與編碼器傳送到實時活動。
RTMP	string	RTMP 輸入會由貢獻編碼器傳送到即時活動。

LiveEventInputTrackSelection

追蹤選取條件。此屬性保留供日後使用，將會忽略此屬性上設定的任何值。

名稱	類型	Description
operation	string	比較作業。此屬性保留供日後使用，將會忽略此屬性上設定的任何值。
property	string	要選取的屬性名稱。此屬性保留供日後使用，將會忽略此屬性上設定的任何值。
value	string	要選取的屬性值。此屬性保留供日後使用，將會忽略此屬性上設定的任何值。

LiveEventOutputTranscriptionTrack

描述即時活動輸出中的轉譯追蹤，其使用語音轉換文字轉譯所產生的文字記錄。此屬性保留供日後使用，將會忽略此屬性上設定的任何值。

名稱	類型	Description
trackName	string	輸出追蹤名稱。此屬性保留供日後使用，將會忽略此屬性上設定的任何值。

LiveEventPreview

即時活動預覽設定。

名稱	類型	Description
accessControl	LiveEventPreviewAccessControl	即時活動預覽的訪問控制。
alternativeMediaId	string	與為預覽建立的串流定位器相關聯的替代媒體標識碼。此值是在建立時指定，而且無法更新。標識符可用於 CustomLicenseAcquisitionUrlTemplate 或 StreamingPolicyName 字段中所指定 StreamingPolicy 的 CustomKeyAcquisitionUrlTemplate。
endpoints	LiveEventEndpoint[]	預覽的端點。請勿與即時活動對象共用預覽 URL。
previewLocator	string	以 Guid 格式的預覽定位器識別碼。在建立時指定此專案，可讓呼叫端在建立事件之前知道預覽定位器 URL。如果省略，服務將會產生隨機標識符。建立即時活動之後，就無法更新此值。
streamingPolicyName	string	用於即時活動預覽的串流原則名稱。此值是在建立時指定，而且無法更新。

LiveEventPreviewAccessControl

即時事件預覽端點的IP訪問控制。

名稱	類型	Description
ip	IPAccessControl	IP 存取控制屬性。

LiveEventResourceState

即時活動的資源狀態。如需相關資訊，請參閱 https://go.microsoft.com/fwlink/?linkid=2139012 。

名稱	類型	Description
Allocating	string	在即時活動上呼叫配置動作，且正在為此實況活動布建資源。配置成功完成之後，即時活動就會轉換為 StandBy 狀態。
Deleting	string	正在刪除即時事件。此暫時性狀態中不會計費。在此狀態期間，不允許任何更新或串流。
Running	string	已配置即時事件資源、已產生擷取和預覽 URL，並且能夠接收即時串流。此時已開始計費。您必須在即時活動資源上明確呼叫「停止」，才能終止進一步計費。
StandBy	string	已布建即時活動資源，並已準備好開始。此狀態會進行計費。大部分的屬性仍然可以進行更新，不過在此狀態期間不允許擷取或串流。
Starting	string	即時活動正在啟動，且正在配置資源。此狀態中不會計費。在此狀態期間，不允許任何更新或串流。如果發生錯誤，則即時事件會回復為 [已停止] 狀態。
Stopped	string	除非 autostart 設定為 true.) 沒有在此狀態中發生任何計費，否則這是建立 (之後實況活動的初始狀態。在此狀態下，可以更新即時活動屬性，但不允許串流。
Stopping	string	正在停止即時事件，而且正在將資源取消佈建。此暫時性狀態中不會計費。在此狀態期間，不允許任何更新或串流。

LiveEventTimedMetadataEndpoint

即時事件元數據插入端點。

名稱	類型	Description
url	string	元數據端點 URL。

LiveEventTranscription

描述即時活動的輸出中的轉譯追蹤，其使用語音轉換文字文字轉譯產生。此屬性保留供日後使用，將會忽略此屬性上設定的任何值。

名稱	類型	Description
inputTrackSelection	LiveEventInputTrackSelection[]	提供在輸入即時摘要中選取音訊曲目的機制，以套用語音轉換文字轉譯。此屬性保留供日後使用，將會忽略此屬性上設定的任何值。
language	string	指定要用於語音轉換文字轉譯的語言 (地區設定) ，它應該符合音訊播放軌中的口語語言。此值應採用 BCP-47 格式 (例如：『en-US』) 。如需即時轉譯功能和支援語言清單的詳細資訊，請參閱 https://go.microsoft.com/fwlink/?linkid=2133742 。
outputTranscriptionTrack	LiveEventOutputTranscriptionTrack	描述即時活動的輸出中的轉譯追蹤，其使用語音轉換文字轉譯所產生的文字記錄。此屬性保留供日後使用，將會忽略此屬性上設定的任何值。

StreamOptionsFlag

要用於 LiveEvent 的選項。此值會在建立時指定，而且無法更新。陣列專案值的有效值為『Default』和 'LowLatency'。

名稱	類型	Description
Default	string	即時串流，沒有特殊的延遲優化。
LowLatency	string	即時活動藉由減少其內部緩衝區，提供較低的端對端延遲。
LowLatencyV2	string	即時活動已針對端對端延遲進行優化。此選項僅適用於使用 RTMP 輸入編碼即時事件。輸出可以使用 HLS 或 DASH 格式進行串流處理。輸出的封存或 DVR 倒轉長度限制為 6 小時。針對所有其他案例使用「LowLatency」資料流選項。

StretchMode

指定如何調整輸入視訊的大小，以符合所需的輸出解析度 () 。預設值為 None

名稱	類型	Description
AutoFit	string	以信箱或柱子方塊) 填補輸出 (以接受輸出解析度，同時確保輸出中的使用中視訊區域與輸入的外觀比例相同。例如，如果輸入為 1920x1080，且編碼預設會要求 1280x1280，則輸出會位於 1280x1280，其中包含 1280x720 的內部矩形，外觀比例為 16：9，而柱形方塊區域在左邊和右邊為 280 像素寬。
AutoSize	string	覆寫輸出解析度，並將它變更為符合輸入的顯示外觀比例，而不需填補。比方說，如果輸入是 1920x1080，但編碼預設要求 1280x1280，則預設值會遭到覆寫，而輸出將會是 1280x720 (保留 16:9 的輸入外觀比例)。
None	string	嚴格遵循編碼預設中指定的輸出解析度，而不考慮輸入視訊的像素外觀比例或顯示外觀比例。

systemData

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

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

共用方式為