Bandwidth Schedules - Create Or Update

Dienst:

Data Box Edge/Data Box Gateway

API-Version:

2021-02-01

Erstellt oder aktualisiert einen Bandbreitenzeitplan.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}?api-version=2021-02-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
deviceName	path	True	string	Der Gerätename.
name	path	True	string	Der Name des Bandbreitenzeitplans, der hinzugefügt/aktualisiert werden muss.
resourceGroupName	path	True	string	Der Ressourcengruppenname.
subscriptionId	path	True	string	Die Abonnement-ID.
api-version	query	True	string	Die API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.days	True	DayOfWeek[]	Die Wochentage, an dem dieser Zeitplan anwendbar ist.
properties.rateInMbps	True	integer (int32)	Die Bandbreitenrate in Mbps.
properties.start	True	string	Die Startzeit des Zeitplans in UTC.
properties.stop	True	string	Die Stoppzeit des Zeitplans in UTC.

Antworten

Name	Typ	Beschreibung
200 OK	BandwidthSchedule	Der Bandbreitenzeitplan wurde erfolgreich erstellt oder aktualisiert.
202 Accepted		Akzeptierte die Anforderung zum Erstellen oder Aktualisieren des Bandbreitenzeitplans.
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

BandwidthSchedulePut

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1?api-version=2021-02-01

{
  "properties": {
    "start": "0:0:0",
    "stop": "13:59:0",
    "rateInMbps": 100,
    "days": [
      "Sunday",
      "Monday"
    ]
  }
}

Beispiel für eine Antwort

Statuscode:

200

{
  "properties": {
    "start": "00:00:00",
    "stop": "13:59:00",
    "rateInMbps": 100,
    "days": [
      "Sunday",
      "Monday"
    ]
  },
  "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1",
  "name": "bandwidth-1",
  "type": "dataBoxEdgeDevices/bandwidthSchedules"
}

Statuscode:

202

Definitionen

Name	Beschreibung
BandwidthSchedule	Details zum Bandbreitenplan.
CloudError	Eine Fehlerantwort des Diensts.
CloudErrorBody	Eine Fehlerantwort des Diensts.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DayOfWeek	Die Wochentage, an dem dieser Zeitplan anwendbar ist.
SystemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

BandwidthSchedule

Objekt

Details zum Bandbreitenplan.

Name	Typ	Beschreibung
id	string	Die Pfad-ID, die das Objekt eindeutig identifiziert.
name	string	Der Objektname.
properties.days	DayOfWeek[]	Die Wochentage, an dem dieser Zeitplan anwendbar ist.
properties.rateInMbps	integer (int32)	Die Bandbreitenrate in Mbps.
properties.start	string	Die Startzeit des Zeitplans in UTC.
properties.stop	string	Die Stoppzeit des Zeitplans in UTC.
systemData	SystemData	Bandbreitenobjekt im Zusammenhang mit DER ASE-Ressource
type	string	Der hierarchische Typ des Objekts.

CloudError

Objekt

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Die Fehlerdetails.

CloudErrorBody

Objekt

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

DayOfWeek

Enumeration

Die Wochentage, an dem dieser Zeitplan anwendbar ist.

Wert	Beschreibung
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

SystemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Identitätstyp, der die Ressource zuletzt geändert hat.
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.