Streaming Endpoints - Create

Service:

Media Services

API Version:

2022-11-01

Skapa StreamingEndpoint
Skapar en slutpunkt för direktuppspelning.

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-parametrar

Name	I	Obligatorisk	Typ	Description
accountName	path	True	string	Media Services-kontonamnet.
resourceGroupName	path	True	string	Namnet på resursgruppen i Azure-prenumerationen.
streamingEndpointName	path	True	string	Namnet på slutpunkten för direktuppspelning, maximal längd är 24. Regex pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$
subscriptionId	path	True	string	Den unika identifieraren för en Microsoft Azure-prenumeration.
api-version	query	True	string	Den version av API:et som ska användas med klientbegäran.
autoStart	query		boolean	Flaggan anger om resursen ska startas automatiskt när den skapas.

Begärandetext

Name	Obligatorisk	Typ	Description
location	True	string	Den geo-plats där resursen finns
properties.scaleUnits	True	integer	Antalet skalningsenheter. Använd skalningsåtgärden för att justera det här värdet.
properties.accessControl		StreamingEndpointAccessControl	Åtkomstkontrolldefinitionen för slutpunkten för direktuppspelning.
properties.availabilitySetName		string	Den här funktionen är inaktuell, ange inget värde för den här egenskapen.
properties.cdnEnabled		boolean	Den CDN-aktiverade flaggan.
properties.cdnProfile		string	CDN-profilnamnet.
properties.cdnProvider		string	CDN-providernamnet.
properties.crossSiteAccessPolicies		CrossSiteAccessPolicies	Åtkomstprinciper för slutpunkt för direktuppspelning.
properties.customHostNames		string[]	De anpassade värdnamnen för slutpunkten för direktuppspelning
properties.description		string	Beskrivning av slutpunkten för direktuppspelning.
properties.maxCacheAge		integer	Maximal cacheålder
sku		ArmStreamingEndpointCurrentSku	SKU:n för slutpunkten för direktuppspelning.
tags		object	Resurstaggar.

Svar

Name	Typ	Description
200 OK	StreamingEndpoint	OK. Begäran har slutförts.
201 Created	StreamingEndpoint	Skapad. Begäran har accepterats för bearbetning och åtgärden slutförs asynkront. Mer https://go.microsoft.com/fwlink/?linkid=2087017 information om hur du övervakar asynkrona Azure-åtgärder med hjälp av Azure-AsyncOperation svarsrubrik.
Other Status Codes	ErrorResponse	Svaret på strömningsfelet som beskriver varför åtgärden misslyckades.

Exempel

Create a streaming endpoint

Sample Request

HTTP

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
  }
}

Java

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"
  }
}

Definitioner

Name	Description
AkamaiAccessControl	Akamai-åtkomstkontroll
AkamaiSignatureHeaderAuthenticationKey	Autentiseringsnyckel för Akamai-signaturrubrik.
ArmStreamingEndpointCurrentSku	Den aktuella SKU:n för slutpunkten för direktuppspelning.
createdByType	Den typ av identitet som skapade resursen.
CrossSiteAccessPolicies	Klientåtkomstprincipen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
IPAccessControl	IP-åtkomstkontrollen.
IPRange	IP-adressintervallet i CIDR-schemat.
StreamingEndpoint	Slutpunkten för direktuppspelning.
StreamingEndpointAccessControl	Definition av åtkomstkontroll för slutpunkt för direktuppspelning.
StreamingEndpointResourceState	Resurstillståndet för slutpunkten för direktuppspelning.
systemData	Metadata som rör skapande och senaste ändring av resursen.

AkamaiAccessControl

Akamai-åtkomstkontroll

Name	Typ	Description
akamaiSignatureHeaderAuthenticationKeyList	AkamaiSignatureHeaderAuthenticationKey[]	lista över autentiseringsnycklar

AkamaiSignatureHeaderAuthenticationKey

Autentiseringsnyckel för Akamai-signaturrubrik.

Name	Typ	Description
base64Key	string	autentiseringsnyckel
expiration	string	Förfallotiden för autentiseringsnyckeln.
identifier	string	identifierare för nyckeln

ArmStreamingEndpointCurrentSku

Den aktuella SKU:n för slutpunkten för direktuppspelning.

Name	Typ	Description
capacity	integer	SKU-kapaciteten för slutpunkt för direktuppspelning.
name	string	SKU-namnet för slutpunkten för direktuppspelning.

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CrossSiteAccessPolicies

Klientåtkomstprincipen.

Name	Typ	Description
clientAccessPolicy	string	Innehållet i clientaccesspolicy.xml som används av Silverlight.
crossDomainPolicy	string	Innehållet i crossdomain.xml som används av Silverlight.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

IPAccessControl

IP-åtkomstkontrollen.

Name	Typ	Description
allow	IPRange[]	Listan över tillåtna IP-adresser.

IPRange

IP-adressintervallet i CIDR-schemat.

Name	Typ	Description
address	string	IP-adressen.
name	string	Det egna namnet för IP-adressintervallet.
subnetPrefixLength	integer	Prefixlängden för nätmasken (se CIDR-notation).

StreamingEndpoint

Slutpunkten för direktuppspelning.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties.accessControl	StreamingEndpointAccessControl	Åtkomstkontrolldefinitionen för slutpunkten för direktuppspelning.
properties.availabilitySetName	string	Den här funktionen är inaktuell, ange inget värde för den här egenskapen.
properties.cdnEnabled	boolean	Den CDN-aktiverade flaggan.
properties.cdnProfile	string	CDN-profilnamnet.
properties.cdnProvider	string	CDN-providernamnet.
properties.created	string	Den exakta tiden då slutpunkten för direktuppspelning skapades.
properties.crossSiteAccessPolicies	CrossSiteAccessPolicies	Åtkomstprinciper för slutpunkt för direktuppspelning.
properties.customHostNames	string[]	De anpassade värdnamnen för slutpunkten för direktuppspelning
properties.description	string	Beskrivning av slutpunkten för direktuppspelning.
properties.freeTrialEndTime	string	Förfallotid för den kostnadsfria utvärderingsversionen.
properties.hostName	string	Värdnamnet för slutpunkten för direktuppspelning.
properties.lastModified	string	Den exakta tiden då slutpunkten för direktuppspelning senast ändrades.
properties.maxCacheAge	integer	Maximal cacheålder
properties.provisioningState	string	Etableringstillståndet för slutpunkten för direktuppspelning.
properties.resourceState	StreamingEndpointResourceState	Resurstillståndet för slutpunkten för direktuppspelning.
properties.scaleUnits	integer	Antalet skalningsenheter. Använd skalningsåtgärden för att justera det här värdet.
sku	ArmStreamingEndpointCurrentSku	SKU:n för slutpunkten för direktuppspelning.
systemData	systemData	Systemmetadata som är relaterade till den här resursen.
tags	object	Resurstaggar.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

StreamingEndpointAccessControl

Definition av åtkomstkontroll för slutpunkt för direktuppspelning.

Name	Typ	Description
akamai	AkamaiAccessControl	Åtkomstkontrollen för Akamai
ip	IPAccessControl	IP-åtkomstkontrollen för slutpunkten för direktuppspelning.

StreamingEndpointResourceState

Resurstillståndet för slutpunkten för direktuppspelning.

Name	Typ	Description
Deleting	string	Slutpunkten för direktuppspelning tas bort.
Running	string	Slutpunkten för direktuppspelning körs. Den kan strömma innehåll till klienter
Scaling	string	Slutpunkten för direktuppspelning ökar eller minskar skalningsenheter.
Starting	string	Slutpunkten för direktuppspelning övergår till körningstillståndet.
Stopped	string	Det ursprungliga tillståndet för en slutpunkt för direktuppspelning när den har skapats. Innehållet är inte redo att strömmas från den här slutpunkten.
Stopping	string	Slutpunkten för direktuppspelning övergår till stoppat tillstånd.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.