Portal Revision - Create Or Update

Usługa:: API Management

Wersja interfejsu API:: 2024-05-01

Tworzy poprawkę nowego portalu dla deweloperów, uruchamiając publikowanie portalu. Właściwość isCurrent wskazuje, czy poprawka jest publicznie dostępna.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
portalRevisionId	path	True	string minLength: 1 maxLength: 256	Identyfikator poprawki portalu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nazwa usługi API Management.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
properties.description	string maxLength: 2000	Opis poprawki portalu.
properties.isCurrent	boolean	Wskazuje, czy poprawka portalu jest publiczna.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	PortalRevisionContract	Poprawka portalu dla deweloperów została pomyślnie utworzona. Nagłówki ETag: string location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Nazwa

Typ

Opis

201 Created

PortalRevisionContract

Poprawka portalu dla deweloperów została pomyślnie utworzona.

Nagłówki

ETag: string
location: string
Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementCreatePortalRevision

Przykładowe żądanie

HTTP

PUT 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 1",
    "isCurrent": true
  }
}

Przykładowa odpowiedź

Kod stanu:: 201

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=5faf089b1d9a026694220e0c&asyncCode=201
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5faf089b1d9a026694220e0c?api-version=2024-05-01

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010",
  "type": "Microsoft.ApiManagement/service/portalRevisions",
  "name": "20201112101010",
  "properties": {
    "description": "portal revision 1",
    "statusDetails": null,
    "status": "completed",
    "isCurrent": true,
    "createdDateTime": "2020-11-13T22:28:43.657Z",
    "updatedDateTime": "2020-11-13T22:29:22.68Z",
    "provisioningState": "InProgress"
  }
}

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
PortalRevisionContract	Szczegóły umowy poprawki portalu.
portalRevisionStatus	Stan poprawki portalu.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

PortalRevisionContract

Objekt

Szczegóły umowy poprawki portalu.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.createdDateTime	string (date-time)	Data i godzina utworzenia poprawki portalu.
properties.description	string maxLength: 2000	Opis poprawki portalu.
properties.isCurrent	boolean	Wskazuje, czy poprawka portalu jest publiczna.
properties.provisioningState	string	Stan aprowizacji
properties.status	portalRevisionStatus	Stan poprawki portalu.
properties.statusDetails	string maxLength: 2000	Szczegóły stanu publikowania poprawek w portalu.
properties.updatedDateTime	string (date-time)	Data i godzina ostatniej aktualizacji.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

portalRevisionStatus

Wyliczanie

Stan poprawki portalu.

Wartość	Opis
pending	Poprawka portalu została dodana do kolejki.
publishing	Trwa publikowanie poprawki portalu.
completed	Publikowanie poprawek w portalu zostało ukończone.
failed	Publikowanie poprawek portalu nie powiodło się.