Portal Revision - Update

Aggiorna la descrizione della revisione del portale specificata o la rende corrente.

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

Parametri dell'URI

Name In Required Type Description
portalRevisionId
path True
  • string

Identificatore di revisione del portale. Deve essere univoco nell'istanza del API Management corrente.

resourceGroupName
path True
  • string

Nome del gruppo di risorse.

serviceName
path True
  • string

Nome del servizio API Management servizio.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Credenziali di sottoscrizione che identificano in modo univoco Microsoft Azure sottoscrizione. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.

api-version
query True
  • string

Versione dell'API da usare con la richiesta client.

Intestazione della richiesta

Name Required Type Description
If-Match True
  • string

ETag dell'entità. ETag deve corrispondere allo stato dell'entità corrente dalla risposta dell'intestazione della richiesta GET oppure deve essere * per l'aggiornamento non condizionale.

Corpo della richiesta

Name Type Description
properties.description
  • string

Descrizione della revisione del portale.

properties.isCurrent
  • boolean

Indica se la revisione del portale è pubblica.

Risposte

Name Type Description
200 OK

La revisione del portale per sviluppatori è stata aggiornata correttamente.

Headers

  • ETag: string
202 Accepted

La richiesta di aggiornamento della revisione del portale per sviluppatori è stata accettata.

Other Status Codes

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Azure Active Directory flusso OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation rappresentare l'account utente

Esempio

ApiManagementUpdatePortalRevision

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010?api-version=2021-01-01-preview
If-Match: *
{
  "properties": {
    "description": "portal revision update",
    "isCurrent": true
  }
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalRevisions/20201112101010?api-version=2021-01-01-preview&asyncId=5faf16b81d9a028970d0bfbb&asyncCode=200
{
  "id": "/subscriptions/subid/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"
  }
}

Definizioni

ErrorFieldContract

Contratto del campo di errore.

ErrorResponse

Risposta all'errore.

PortalRevisionContract

Dettagli del contratto della revisione del portale.

portalRevisionStatus

Stato della revisione del portale.

ErrorFieldContract

Contratto del campo di errore.

Name Type Description
code
  • string

Codice di errore a livello di proprietà.

message
  • string

Rappresentazione leggibile dell'errore a livello di proprietà.

target
  • string

Nome della proprietà.

ErrorResponse

Risposta all'errore.

Name Type Description
error.code
  • string

Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.

error.details

Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.

error.message
  • string

Rappresentazione leggibile dell'errore.

PortalRevisionContract

Dettagli del contratto della revisione del portale.

Name Type Description
id
  • string

ID risorsa.

name
  • string

Nome della risorsa.

properties.createdDateTime
  • string

Data e ora di creazione della revisione del portale.

properties.description
  • string

Descrizione della revisione del portale.

properties.isCurrent
  • boolean

Indica se la revisione del portale è pubblica.

properties.status

Stato della revisione del portale.

properties.statusDetails
  • string

Dettagli sullo stato di pubblicazione della revisione del portale.

properties.updatedDateTime
  • string

Data e ora dell'ultimo aggiornamento.

type
  • string

Tipo di risorsa per API Management risorsa.

portalRevisionStatus

Stato della revisione del portale.

Name Type Description
completed
  • string

Pubblicazione delle revisioni del portale completata.

failed
  • string

Pubblicazione delle revisioni del portale non riuscita.

pending
  • string

La revisione del portale è stata accodata.

publishing
  • string

È in corso la pubblicazione della revisione del portale.