Workspace Api - Update

Servizio:: API Management

Versione API:: 2024-05-01

Aggiorna l'API specificata dell'area di lavoro in un'istanza del servizio Gestione API.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nome del servizio Gestione API.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
If-Match	True	string	ETag dell'entità. ETag deve corrispondere allo stato corrente dell'entità dalla risposta dell'intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.apiRevision	string minLength: 1 maxLength: 100	Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1
properties.apiRevisionDescription	string maxLength: 256	Descrizione della revisione DELL'API.
properties.apiVersion	string maxLength: 100	Indica l'identificatore della versione dell'API se l'API è con versione
properties.apiVersionDescription	string maxLength: 256	Descrizione della versione dell'API.
properties.apiVersionSetId	string	Identificatore di risorsa per l'Oggetto ApiVersionSet correlato.
properties.authenticationSettings	AuthenticationSettingsContract	Raccolta di impostazioni di autenticazione incluse in questa API.
properties.contact	ApiContactInformation	Informazioni di contatto per l'API.
properties.description	string	Descrizione dell'API. Può includere tag di formattazione HTML.
properties.displayName	string minLength: 1 maxLength: 300	Nome API.
properties.isCurrent	boolean	Indica se la revisione dell'API è la revisione api corrente.
properties.license	ApiLicenseInformation	Informazioni sulla licenza per l'API.
properties.path	string minLength: 0 maxLength: 400	URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi di risorse all'interno dell'istanza del servizio Gestione API. Viene aggiunto all'URL di base dell'endpoint API specificato durante la creazione dell'istanza del servizio per formare un URL pubblico per questa API.
properties.protocols	Protocol[]	Descrive i protocolli in cui è possibile richiamare le operazioni in questa API.
properties.serviceUrl	string minLength: 1 maxLength: 2000	URL assoluto del servizio back-end che implementa questa API.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protocolli su cui è disponibile l'API.
properties.subscriptionRequired	boolean	Specifica se è necessaria una sottoscrizione api o prodotto per l'accesso all'API.
properties.termsOfServiceUrl	string	URL delle condizioni di servizio per l'API. DEVE essere nel formato di un URL.
properties.type	ApiType	Tipo di API.

Risposte

Nome	Tipo	Descrizione
200 OK	ApiContract	L'API è stata aggiornata correttamente. Intestazioni ETag: string
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Nome

Tipo

Descrizione

200 OK

ApiContract

L'API è stata aggiornata correttamente.

Intestazioni

ETag: string

Other Status Codes

ErrorResponse

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

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementUpdateWorkspaceApi

Esempio di richiesta

HTTP

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


{
  "properties": {
    "displayName": "Echo API New",
    "serviceUrl": "http://echoapi.cloudapp.net/api2",
    "path": "newecho"
  }
}

Risposta di esempio

Codice di stato:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api",
  "type": "Microsoft.ApiManagement/service/workspaces/pis",
  "name": "echo-api",
  "properties": {
    "displayName": "Echo API New",
    "apiRevision": "1",
    "serviceUrl": "http://echoapi.cloudapp.net/api2",
    "path": "newecho",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true,
    "isOnline": true
  }
}

Definizioni

Nome	Descrizione
ApiContactInformation	Informazioni di contatto dell'API
ApiContract	Dettagli API.
ApiLicenseInformation	Informazioni sulle licenze API
ApiType	Tipo di API.
ApiUpdateContract	Dettagli del contratto di aggiornamento API.
ApiVersionSetContractDetails	Un set di versioni dell'API contiene la configurazione comune per un set di versioni dell'API correlate
AuthenticationSettingsContract	Impostazioni di autenticazione API.
bearerTokenSendingMethods	Come inviare il token al server.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
OAuth2AuthenticationSettingsContract	Dettagli delle impostazioni di autenticazione OAuth2 dell'API.
OpenIdAuthenticationSettingsContract	Dettagli delle impostazioni di autenticazione OAuth2 dell'API.
Protocol	Descrive i protocolli in cui è possibile richiamare le operazioni in questa API.
SubscriptionKeyParameterNamesContract	Dettagli dei nomi dei parametri della chiave di sottoscrizione.
versioningScheme	Valore che determina dove si trova l'identificatore della versione dell'API in una richiesta HTTP.

ApiContactInformation

Object

Informazioni di contatto dell'API

Nome	Tipo	Descrizione
email	string	Indirizzo di posta elettronica della persona o dell'organizzazione di contatto. DEVE essere nel formato di un indirizzo di posta elettronica
name	string	Nome di identificazione della persona o dell'organizzazione di contatto
url	string	URL che punta alle informazioni di contatto. DEVE essere nel formato di un URL

ApiContract

Object

Dettagli API.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nome della risorsa
properties.apiRevision	string minLength: 1 maxLength: 100	Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1
properties.apiRevisionDescription	string maxLength: 256	Descrizione della revisione DELL'API.
properties.apiVersion	string maxLength: 100	Indica l'identificatore della versione dell'API se l'API è con versione
properties.apiVersionDescription	string maxLength: 256	Descrizione della versione dell'API.
properties.apiVersionSet	ApiVersionSetContractDetails	Dettagli del set di versioni
properties.apiVersionSetId	string	Identificatore di risorsa per l'Oggetto ApiVersionSet correlato.
properties.authenticationSettings	AuthenticationSettingsContract	Raccolta di impostazioni di autenticazione incluse in questa API.
properties.contact	ApiContactInformation	Informazioni di contatto per l'API.
properties.description	string	Descrizione dell'API. Può includere tag di formattazione HTML.
properties.displayName	string minLength: 1 maxLength: 300	Nome API. Deve contenere da 1 a 300 caratteri.
properties.isCurrent	boolean	Indica se la revisione dell'API è la revisione api corrente.
properties.isOnline	boolean	Indica se la revisione dell'API è accessibile tramite il gateway.
properties.license	ApiLicenseInformation	Informazioni sulla licenza per l'API.
properties.path	string minLength: 0 maxLength: 400	URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi di risorse all'interno dell'istanza del servizio Gestione API. Viene aggiunto all'URL di base dell'endpoint API specificato durante la creazione dell'istanza del servizio per formare un URL pubblico per questa API.
properties.protocols	Protocol[]	Descrive i protocolli in cui è possibile richiamare le operazioni in questa API.
properties.provisioningState	string	Stato del provisioning
properties.serviceUrl	string minLength: 0 maxLength: 2000	URL assoluto del servizio back-end che implementa questa API. Non può contenere più di 2000 caratteri.
properties.sourceApiId	string	Identificatore API dell'API di origine.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protocolli su cui è disponibile l'API.
properties.subscriptionRequired	boolean	Specifica se è necessaria una sottoscrizione api o prodotto per l'accesso all'API.
properties.termsOfServiceUrl	string	URL delle condizioni di servizio per l'API. DEVE essere nel formato di un URL.
properties.type	ApiType	Tipo di API.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

Object

Informazioni sulle licenze API

Nome	Tipo	Descrizione
name	string	Nome della licenza usato per l'API
url	string	URL della licenza usata per l'API. DEVE essere nel formato di un URL

ApiType

Enumerazione

Tipo di API.

Valore	Descrizione
http
soap
websocket
graphql
odata
grpc

ApiUpdateContract

Object

Dettagli del contratto di aggiornamento API.

Nome	Tipo	Descrizione
properties.apiRevision	string minLength: 1 maxLength: 100	Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1
properties.apiRevisionDescription	string maxLength: 256	Descrizione della revisione DELL'API.
properties.apiVersion	string maxLength: 100	Indica l'identificatore della versione dell'API se l'API è con versione
properties.apiVersionDescription	string maxLength: 256	Descrizione della versione dell'API.
properties.apiVersionSetId	string	Identificatore di risorsa per l'Oggetto ApiVersionSet correlato.
properties.authenticationSettings	AuthenticationSettingsContract	Raccolta di impostazioni di autenticazione incluse in questa API.
properties.contact	ApiContactInformation	Informazioni di contatto per l'API.
properties.description	string	Descrizione dell'API. Può includere tag di formattazione HTML.
properties.displayName	string minLength: 1 maxLength: 300	Nome API.
properties.isCurrent	boolean	Indica se la revisione dell'API è la revisione api corrente.
properties.isOnline	boolean	Indica se la revisione dell'API è accessibile tramite il gateway.
properties.license	ApiLicenseInformation	Informazioni sulla licenza per l'API.
properties.path	string minLength: 0 maxLength: 400	URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi di risorse all'interno dell'istanza del servizio Gestione API. Viene aggiunto all'URL di base dell'endpoint API specificato durante la creazione dell'istanza del servizio per formare un URL pubblico per questa API.
properties.protocols	Protocol[]	Descrive i protocolli in cui è possibile richiamare le operazioni in questa API.
properties.serviceUrl	string minLength: 1 maxLength: 2000	URL assoluto del servizio back-end che implementa questa API.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protocolli su cui è disponibile l'API.
properties.subscriptionRequired	boolean	Specifica se è necessaria una sottoscrizione api o prodotto per l'accesso all'API.
properties.termsOfServiceUrl	string	URL delle condizioni di servizio per l'API. DEVE essere nel formato di un URL.
properties.type	ApiType	Tipo di API.

ApiVersionSetContractDetails

Object

Un set di versioni dell'API contiene la configurazione comune per un set di versioni dell'API correlate

Nome	Tipo	Descrizione
description	string	Descrizione del set di versioni dell'API.
id	string	Identificatore per il set di versioni dell'API esistente. Omettere questo valore per creare un nuovo set di versioni.
name	string	Nome visualizzato del set di versioni dell'API.
versionHeaderName	string	Nome del parametro di intestazione HTTP che indica la versione dell'API se versioningScheme è impostato su `header`.
versionQueryName	string	Nome del parametro di query che indica la versione dell'API se versioningScheme è impostato su `query`.
versioningScheme	versioningScheme	Valore che determina dove si trova l'identificatore della versione dell'API in una richiesta HTTP.

AuthenticationSettingsContract

Object

Impostazioni di autenticazione API.

Nome	Tipo	Descrizione
oAuth2	OAuth2AuthenticationSettingsContract	Impostazioni di autenticazione OAuth2
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Raccolta di impostazioni di autenticazione OAuth2 incluse in questa API.
openid	OpenIdAuthenticationSettingsContract	Impostazioni di autenticazione OpenID Connect
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Raccolta di impostazioni di autenticazione Open ID Connect incluse in questa API.

bearerTokenSendingMethods

Enumerazione

Come inviare il token al server.

Valore	Descrizione
authorizationHeader	Il token di accesso verrà trasmesso nell'intestazione authorization usando lo schema Bearer
query	Il token di accesso verrà trasmesso come parametri di query.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

OAuth2AuthenticationSettingsContract

Object

Dettagli delle impostazioni di autenticazione OAuth2 dell'API.

Nome	Tipo	Descrizione
authorizationServerId	string	Identificatore del server di autorizzazione OAuth.
scope	string	ambito delle operazioni.

OpenIdAuthenticationSettingsContract

Object

Dettagli delle impostazioni di autenticazione OAuth2 dell'API.

Nome	Tipo	Descrizione
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Come inviare il token al server.
openidProviderId	string	Identificatore del server di autorizzazione OAuth.

Protocol

Enumerazione

Descrive i protocolli in cui è possibile richiamare le operazioni in questa API.

Valore	Descrizione
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Object

Dettagli dei nomi dei parametri della chiave di sottoscrizione.

Nome	Tipo	Descrizione
header	string	Nome dell'intestazione della chiave di sottoscrizione.
query	string	Nome del parametro della stringa di query della chiave di sottoscrizione.

versioningScheme

Enumerazione

Valore che determina dove si trova l'identificatore della versione dell'API in una richiesta HTTP.

Valore	Descrizione
Segment	La versione DELL'API viene passata in un segmento di percorso.
Query	La versione dell'API viene passata in un parametro di query.
Header	La versione dell'API viene passata in un'intestazione HTTP.

Condividi tramite

Workspace Api - Update

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

ApiManagementUpdateWorkspaceApi

Esempio di richiesta

Risposta di esempio

Definizioni

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiUpdateContract

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

versioningScheme