openapi-directory/api/azure.com/mediaservices-MediaGraphs.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"This Swagger was generated by the API Framework.","title":"Azure Media Services","version":"2019-09-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/mediaservices/resource-manager/Microsoft.Media/preview/2019-09-01-preview/MediaGraphs.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"mediaservices-MediaGraphs","x-tags":["Azure","Microsoft"]},"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/mediaGraphs":{"get":{"description":"Lists Media Graphs in the Media Services account","operationId":"MediaGraphs_List","parameters":[{"$ref":"#/components/parameters/SubscriptionId"},{"$ref":"#/components/parameters/ResourceGroupName"},{"$ref":"#/components/parameters/MediaServicesAccountName"},{"$ref":"#/components/parameters/ApiVersion"},{"description":"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.","in":"query","name":"$top","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaGraphCollection"},"examples":{"List all Media Graphs":{"$ref":"#/components/examples/List_all_Media_Graphs"}}}}},"default":{"description":"Detailed error information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"summary":"List Media Graphs","x-ms-pageable":{"nextLinkName":"@odata.nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/mediaGraphs/{mediaGraphName}":{"delete":{"description":"Deletes a Media Graph in the Media Services account","operationId":"MediaGraphs_Delete","parameters":[{"$ref":"#/components/parameters/SubscriptionId"},{"$ref":"#/components/parameters/ResourceGroupName"},{"$ref":"#/components/parameters/MediaServicesAccountName"},{"description":"The Media Graph name.","in":"path","name":"mediaGraphName","required":true,"schema":{"type":"string"},"examples":{"Delete a Media Graph":{"value":"SampleMediaGraph"}}},{"$ref":"#/components/parameters/ApiVersion"}],"responses":{"200":{"description":"OK"},"204":{"description":"NoContent"},"default":{"description":"Detailed error information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"summary":"Delete a Media Graph"},"get":{"description":"Get the details of a Media Graph in the Media Services account","operationId":"MediaGraphs_Get","parameters":[{"$ref":"#/components/parameters/SubscriptionId"},{"$ref":"#/components/parameters/ResourceGroupName"},{"$ref":"#/components/parameters/MediaServicesAccountName"},{"description":"The Media Graph name.","in":"path","name":"mediaGraphName","required":true,"schema":{"type":"string"},"examples":{"Get a Media Graph by name":{"value":"SampleMediaGraph1"}}},{"$ref":"#/components/parameters/ApiVersion"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaGraph"},"examples":{"Get a Media Graph by name":{"$ref":"#/components/examples/Get_a_Media_Graph_by_name"}}}}},"404":{"description":"NotFound"},"default":{"description":"Detailed error information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"summary":"Get a Media Graph"},"put":{"description":"Create or update a Media Graph in the Media Services account","operationId":"MediaGraphs_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/SubscriptionId"},{"$ref":"#/components/parameters/ResourceGroupName"},{"$ref":"#/components/parameters/MediaServicesAccountName"},{"description":"The Media Graph name.","in":"path","name":"mediaGraphName","required":true,"schema":{"type":"string"},"examples":{"Create or update a Media Graph":{"value":"SampleMediaGraph"}}},{"$ref":"#/components/parameters/ApiVersion"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaGraph"}}},"description":"The request parameters","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaGraph"},"examples":{"Create or update a Media Graph":{"$ref":"#/components/examples/Create_or_update_a_Media_Graph"}}}}},"default":{"description":"Detailed error information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"summary":"Create or update a Media Graph"}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/mediaGraphs/{mediaGraphName}/operationResults/{operationId}":{"get":{"description":"Get the operation result of a Media Graph in the Media Services account","operationId":"OperationResults_Get","parameters":[{"$ref":"#/components/parameters/SubscriptionId"},{"$ref":"#/components/parameters/ResourceGroupName"},{"$ref":"#/components/parameters/MediaServicesAccountName"},{"description":"The Media Graph name.","in":"path","name":"mediaGraphName","required":true,"schema":{"type":"string"},"examples":{"Get the operation result":{"value":"SampleMediaGraph"}}},{"description":"The operation ID","in":"path","name":"operationId","required":true,"schema":{"type":"string"},"examples":{"Get the operation result":{"value":"7877d0da-ae9b-4c5b-a1fa-c9ece3ef5d11"}}},{"$ref":"#/components/parameters/ApiVersion"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaGraphOperationResult"},"examples":{"Get the operation result":{"$ref":"#/components/examples/Get_the_operation_result"}}}}},"default":{"description":"Detailed error information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"summary":"Get the operation result"}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/mediaGraphs/{mediaGraphName}/operationsStatus/{operationId}":{"get":{"description":"Get the operation status of a Media Graph in the media services account","operationId":"OperationsStatus_Get","parameters":[{"$ref":"#/components/parameters/SubscriptionId"},{"$ref":"#/components/parameters/ResourceGroupName"},{"$ref":"#/components/parameters/MediaServicesAccountName"},{"description":"The Media Graph name.","in":"path","name":"mediaGraphName","required":true,"schema":{"type":"string"},"examples":{"Get the operation status":{"value":"SampleMediaGraph"}}},{"description":"The operation ID","in":"path","name":"operationId","required":true,"schema":{"type":"string"},"examples":{"Get the operation status":{"value":"7877d0da-ae9b-4c5b-a1fa-c9ece3ef5d11"}}},{"$ref":"#/components/parameters/ApiVersion"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaGraphOperationStatus"},"examples":{"Get the operation status":{"$ref":"#/components/examples/Get_the_operation_status"}}}}},"default":{"description":"Detailed error information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"summary":"Get the operation status"}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/mediaGraphs/{mediaGraphName}/start":{"post":{"description":"Start a Media Graph in the Media Services account","operationId":"MediaGraphs_Start","parameters":[{"$ref":"#/components/parameters/SubscriptionId"},{"$ref":"#/components/parameters/ResourceGroupName"},{"$ref":"#/components/parameters/MediaServicesAccountName"},{"description":"The Media Graph name.","in":"path","name":"mediaGraphName","required":true,"schema":{"type":"string"},"examples":{"Start Media Graph":{"value":"SampleMediaGraph"}}},{"$ref":"#/components/parameters/ApiVersion"}],"responses":{"200":{"description":"OK"},"202":{"description":"Accepted"},"default":{"description":"Detailed error information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"summary":"Start a Media Graph","x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/mediaGraphs/{mediaGraphName}/stop":{"post":{"description":"Stop a Media Graph in the Media Services account","operationId":"MediaGraphs_Stop","parameters":[{"$ref":"#/components/parameters/SubscriptionId"},{"$ref":"#/components/parameters/ResourceGroupName"},{"$ref":"#/components/parameters/MediaServicesAccountName"},{"description":"The Media Graph name.","in":"path","name":"mediaGraphName","required":true,"schema":{"type":"string"},"examples":{"Stop Media Graph":{"value":"SampleMediaGraph"}}},{"$ref":"#/components/parameters/ApiVersion"}],"responses":{"200":{"description":"OK"},"202":{"description":"Accepted"},"default":{"description":"Detailed error information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"summary":"Stop a Media Graph","x-ms-long-running-operation":true}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_all_Media_Graphs":{"value":{"value":[{"name":"SampleMediaGraph0","properties":{"created":"2019-09-01T00:00:00Z","description":"","lastModified":"2019-09-01T00:00:00Z","sinks":[{"@odata.type":"#Microsoft.Media.MediaGraphAssetSink","assetName":"Sample Asset0","inputs":["RTSPSource0"],"name":"AssetSink0"}],"sources":[{"@odata.type":"#Microsoft.Media.MediaGraphRtspSource","name":"RTSPSource0","rtspUrl":"rtsp://contoso.com:554/stream0"}],"state":"Stopped"}},{"name":"SampleMediaGraph1","properties":{"created":"2019-09-01T00:00:00Z","description":"","lastModified":"2019-09-01T00:00:00Z","sinks":[{"@odata.type":"#Microsoft.Media.MediaGraphAssetSink","assetName":"Sample Asset1","inputs":["RTSPSource1"],"name":"AssetSink1"}],"sources":[{"@odata.type":"#Microsoft.Media.MediaGraphRtspSource","name":"RTSPSource1","rtspUrl":"rtsp://contoso.com:554/stream1"}],"state":"Stopped"}},{"name":"SampleMediaGraph2","properties":{"created":"2019-09-01T00:00:00Z","description":"","lastModified":"2019-09-01T00:00:00Z","sinks":[{"@odata.type":"#Microsoft.Media.MediaGraphAssetSink","assetName":"Sample Asset2","inputs":["RTSPSource2"],"name":"AssetSink2"}],"sources":[{"@odata.type":"#Microsoft.Media.MediaGraphRtspSource","name":"RTSPSource2","rtspUrl":"rtsp://contoso.com:554/stream2"}],"state":"Stopped"}}]}},"Get_a_Media_Graph_by_name":{"value":{"name":"SampleMediaGraph1","properties":{"created":"2019-09-01T00:00:00Z","description":"","lastModified":"2019-09-01T00:00:00Z","sinks":[{"@odata.type":"#Microsoft.Media.MediaGraphAssetSink","assetName":"Sample Asset1","inputs":["RTSPSource1"],"name":"AssetSink1"}],"sources":[{"@odata.type":"#Microsoft.Media.MediaGraphRtspSource","name":"RTSPSource1","rtspUrl":"rtsp://contoso.com:554/stream1"}],"state":"Stopped"}}},"Create_or_update_a_Media_Graph":{"value":{"name":"SampleMediaGraph","properties":{"created":"2019-09-01T00:00:00Z","description":"updated description","lastModified":"2019-09-01T00:00:00Z","sinks":[{"@odata.type":"#Microsoft.Media.MediaGraphAssetSink","assetName":"SampleAsset","inputs":["rtspSource"],"name":"AssetSink"}],"sources":[{"@odata.type":"#Microsoft.Media.MediaGraphRtspSource","name":"rtspSource","rtspUrl":"rtsp://contoso.com:554/stream1"}],"state":"Stopped"}}},"Get_the_operation_result":{"value":{}},"Get_the_operation_status":{"value":{"name":"7877d0da-ae9b-4c5b-a1fa-c9ece3ef5d11","status":"Succeeded"}}},"parameters":{"ApiVersion":{"description":"The Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List all Media Graphs":{"value":"2019-09-01-preview"},"Delete a Media Graph":{"value":"2019-09-01-preview"},"Get a Media Graph by name":{"value":"2019-09-01-preview"},"Create or update a Media Graph":{"value":"2019-09-01-preview"},"Get the operation result":{"value":"2019-09-01-preview"},"Get the operation status":{"value":"2019-09-01-preview"},"Start Media Graph":{"value":"2019-09-01-preview"},"Stop Media Graph":{"value":"2019-09-01-preview"}}},"MediaServicesAccountName":{"description":"The Media Services account name.","in":"path","name":"accountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"List all Media Graphs":{"value":"contosomedia"},"Delete a Media Graph":{"value":"contosomedia"},"Get a Media Graph by name":{"value":"contosomedia"},"Create or update a Media Graph":{"value":"contosomedia"},"Get the operation result":{"value":"contosomedia"},"Get the operation status":{"value":"contosomedia"},"Start Media Graph":{"value":"contosomedia"},"Stop Media Graph":{"value":"contosomedia"}}},"ResourceGroupName":{"description":"The name of the resource group within the Azure subscription.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"List all Media Graphs":{"value":"contoso"},"Delete a Media Graph":{"value":"contoso"},"Get a Media Graph by name":{"value":"contoso"},"Create or update a Media Graph":{"value":"contoso"},"Get the operation result":{"value":"contoso"},"Get the operation status":{"value":"contoso"},"Start Media Graph":{"value":"contoso"},"Stop Media Graph":{"value":"contoso"}}},"SubscriptionId":{"description":"The unique identifier for a Microsoft Azure subscription.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List all Media Graphs":{"value":"00000000-0000-0000-0000-000000000000"},"Delete a Media Graph":{"value":"00000000-0000-0000-0000-000000000000"},"Get a Media Graph by name":{"value":"00000000-0000-0000-0000-000000000000"},"Create or update a Media Graph":{"value":"00000000-0000-0000-0000-000000000000"},"Get the operation result":{"value":"00000000-0000-0000-0000-000000000000"},"Get the operation status":{"value":"00000000-0000-0000-0000-000000000000"},"Start Media Graph":{"value":"00000000-0000-0000-0000-000000000000"},"Stop Media Graph":{"value":"00000000-0000-0000-0000-000000000000"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"Impersonate your user account"}}}}},"schemas":{"ApiError":{"description":"The API error.","properties":{"error":{"$ref":"#/components/schemas/ODataError"}},"type":"object"},"MediaGraph":{"allOf":[{"allOf":[{"description":"The core properties of ARM resources.","properties":{"id":{"description":"Fully qualified resource ID for the resource.","readOnly":true,"type":"string"},"name":{"description":"The name of the resource.","readOnly":true,"type":"string"},"type":{"description":"The type of the resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"The resource model definition for a ARM proxy resource."}],"description":"The Media Graph.","properties":{"properties":{"$ref":"#/components/schemas/MediaGraphProperties"}},"type":"object"},"MediaGraphAssetSink":{"allOf":[{"$ref":"#/components/schemas/MediaGraphSink"}],"description":"Asset sink","properties":{"assetName":{"description":"Asset name","type":"string"}},"required":["assetName"],"type":"object","x-ms-discriminator-value":"#Microsoft.Media.MediaGraphAssetSink"},"MediaGraphCollection":{"description":"A collection of MediaGraph items.","properties":{"@odata.nextLink":{"description":"A link to the next page of the collection (when the collection contains too many results to return in one response).","type":"string"},"value":{"description":"A collection of MediaGraph items.","items":{"$ref":"#/components/schemas/MediaGraph"},"type":"array"}},"type":"object"},"MediaGraphOperationError":{"description":"The operation error","properties":{"code":{"description":"The operation error code","type":"string"},"message":{"description":"The operation error message","type":"string"}},"type":"object"},"MediaGraphOperationResult":{"description":"The result of the Media Graph operation","properties":{},"type":"object"},"MediaGraphOperationStatus":{"description":"The status of the Media Graph operation","properties":{"error":{"$ref":"#/components/schemas/MediaGraphOperationError"},"name":{"description":"The name of the Media Graph operation","type":"string"},"status":{"description":"The status of the Media Graph operation","type":"string"}},"required":["name"],"type":"object"},"MediaGraphProperties":{"description":"Class for Media Graph properties","properties":{"created":{"description":"Date the Media Graph was created","format":"date-time","readOnly":true,"type":"string","nullable":false},"description":{"description":"Media Graph  description","type":"string"},"lastModified":{"description":"Date the Media Graph was last modified","format":"date-time","readOnly":true,"type":"string","nullable":false},"sinks":{"description":"Media Graph sinks","items":{"$ref":"#/components/schemas/MediaGraphSink"},"type":"array"},"sources":{"description":"Media Graph sources","items":{"$ref":"#/components/schemas/MediaGraphSource"},"type":"array"},"state":{"description":"Media Graph state","enum":["Running","Starting","Stopped","Stopping"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"MediaGraphState","values":[{"description":"Media Graph is Running","value":"Running"},{"description":"Media Graph is Starting","value":"Starting"},{"description":"Media Graph has Stopped","value":"Stopped"},{"description":"Media Graph is Stopping","value":"Stopping"}]},"nullable":false}},"required":["sources","sinks"],"type":"object"},"MediaGraphRtspSource":{"allOf":[{"$ref":"#/components/schemas/MediaGraphSource"}],"description":"RTSP source","properties":{"credentials":{"$ref":"#/components/schemas/MediaGraphUserCredentials"},"rtspUrl":{"description":"RTSP URL","type":"string"}},"required":["rtspUrl"],"type":"object","x-ms-discriminator-value":"#Microsoft.Media.MediaGraphRtspSource"},"MediaGraphSink":{"description":"Media Sink","discriminator":{"propertyName":"@odata.type"},"properties":{"@odata.type":{"description":"The discriminator for derived types.","type":"string"},"inputs":{"description":"Sink inputs","items":{"type":"string"},"type":"array"},"name":{"description":"Sink name","type":"string"}},"required":["@odata.type","name","inputs"],"type":"object"},"MediaGraphSource":{"description":"Media source","discriminator":{"propertyName":"@odata.type"},"properties":{"@odata.type":{"description":"The discriminator for derived types.","type":"string"},"name":{"description":"Source name","type":"string"}},"required":["@odata.type","name"],"type":"object"},"MediaGraphUserCredentials":{"description":"Credentials to authenticate to Media Graph sources","properties":{"password":{"description":"Password credential","type":"string"},"username":{"description":"User name","type":"string"}},"required":["username","password"],"type":"object"},"ODataError":{"description":"Information about an error.","properties":{"code":{"description":"A language-independent error name.","type":"string"},"details":{"description":"The error details.","items":{"$ref":"#/components/schemas/ODataError"},"type":"array"},"message":{"description":"The error message.","type":"string"},"target":{"description":"The target of the error (for example, the name of the property in error).","type":"string"}},"type":"object"}}}}