Portal Revision - Update

Dienst:

API Management

API-Version:

2024-05-01

Aktualisiert die Beschreibung der angegebenen Portalrevision oder macht sie aktuell.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalRevisions/{portalRevisionId}?api-version=2024-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
portalRevisionId	path	True	string minLength: 1 maxLength: 256	Bezeichner der Portalrevision. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match	True	string	ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.

Anforderungstext

Name	Typ	Beschreibung
properties.description	string maxLength: 2000	Beschreibung der Portalrevision.
properties.isCurrent	boolean	Gibt an, ob die Überarbeitung des Portals öffentlich ist.

Antworten

Name	Typ	Beschreibung
200 OK	PortalRevisionContract	Die Überarbeitung des Entwicklerportals wurde erfolgreich aktualisiert. Header ETag: string
202 Accepted		Anforderung zum Aktualisieren der Überarbeitung des Entwicklerportals wurde akzeptiert. Header location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	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

ApiManagementUpdatePortalRevision

Beispielanforderung

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010?api-version=2024-05-01


{
  "properties": {
    "description": "portal revision update",
    "isCurrent": true
  }
}

Beispiel für eine Antwort

Statuscode:

202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010?api-version=2024-05-01&asyncId=5faf16b81d9a028970d0bfbb&asyncCode=200
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5faf16b81d9a028970d0bfbb?api-version=2024-05-01

Statuscode:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2",
  "type": "Microsoft.ApiManagement/service/portalRevisions",
  "name": "20201112101010",
  "properties": {
    "description": "portal revision update",
    "statusDetails": null,
    "status": "completed",
    "isCurrent": true,
    "createdDateTime": "2020-11-13T22:47:13.397Z",
    "updatedDateTime": "2020-11-13T23:29:25.34Z"
  }
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
PortalRevisionContract	Vertragsdetails der Portalrevision.
portalRevisionStatus	Status der Überarbeitung des Portals.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

PortalRevisionContract

Objekt

Vertragsdetails der Portalrevision.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.createdDateTime	string (date-time)	Das Erstellungsdatum und die Uhrzeit der Überarbeitung des Portals.
properties.description	string maxLength: 2000	Beschreibung der Portalrevision.
properties.isCurrent	boolean	Gibt an, ob die Überarbeitung des Portals öffentlich ist.
properties.provisioningState	string	Der Bereitstellungsstatus
properties.status	portalRevisionStatus	Status der Überarbeitung des Portals.
properties.statusDetails	string maxLength: 2000	Details zum Veröffentlichungsstatus der Portalrevision.
properties.updatedDateTime	string (date-time)	Datum und Uhrzeit der letzten Aktualisierung.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

portalRevisionStatus

Enumeration

Status der Überarbeitung des Portals.

Wert	Beschreibung
completed	Die Überarbeitungsveröffentlichung des Portals wurde abgeschlossen.
failed	Fehler bei der Überarbeitungsveröffentlichung des Portals.
pending	Die Überarbeitung des Portals wurde in die Warteschlange gestellt.
publishing	Die Überarbeitung des Portals wird veröffentlicht.