Condividi tramite


Workspace Api - Update

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=2023-09-01-preview

Parametri dell'URI

Nome In Necessario Tipo Descrizione
apiId
path True

string

Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso in cui n è il numero di revisione.

Criterio di espressione regolare: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName
path True

string

Nome del servizio Gestione API.

Criterio di espressione regolare: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

uuid

ID della sottoscrizione di destinazione. Il valore deve essere un UUID.

workspaceId
path True

string

Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.

Criterio di espressione regolare: ^[^*#&+:<>?]+$

api-version
query True

string

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 dell'entità corrente dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

Corpo della richiesta

Nome Tipo Descrizione
properties.apiRevision

string

Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1

properties.apiRevisionDescription

string

Descrizione della revisione DELL'API.

properties.apiVersion

string

Indica l'identificatore della versione dell'API se l'API è in versione

properties.apiVersionDescription

string

Descrizione della versione dell'API.

properties.apiVersionSetId

string

Identificatore di risorsa per 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

Nome API.

properties.isCurrent

boolean

Indica se la revisione dell'API è la revisione dell'API corrente.

properties.license

ApiLicenseInformation

Informazioni sulla licenza per l'API.

properties.path

string

URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi delle 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 in modo da formare un URL pubblico per questa API.

properties.protocols

Protocol[]

Descrive su quali protocolli è possibile richiamare le operazioni in questa API.

properties.serviceUrl

string

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 Product 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 perché 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

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=2023-09-01-preview


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

Risposta di esempio

{
  "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 dell'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 API correlate

AuthenticationSettingsContract

Impostazioni di autenticazione API.

bearerTokenSendingMethods

Come inviare il token al server.

ErrorAdditionalInfo

Informazioni aggiuntive sulla 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 su quali protocolli è 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 API in una richiesta HTTP.

ApiContactInformation

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

Dettagli dell'API.

Nome Tipo Descrizione
id

string

ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nome della risorsa.

properties.apiRevision

string

Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1

properties.apiRevisionDescription

string

Descrizione della revisione dell'API.

properties.apiVersion

string

Indica l'identificatore della versione dell'API se l'API è con versione

properties.apiVersionDescription

string

Descrizione della versione dell'API.

properties.apiVersionSet

ApiVersionSetContractDetails

Dettagli del set di versioni

properties.apiVersionSetId

string

Identificatore di risorsa per l'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

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

URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi delle 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 in modo da formare un URL pubblico per questa API.

properties.protocols

Protocol[]

Descrive su quali protocolli è possibile richiamare le operazioni in questa API.

properties.provisioningState

string

Stato del provisioning

properties.serviceUrl

string

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 viene resa disponibile l'API.

properties.subscriptionRequired

boolean

Specifica se è necessaria una sottoscrizione API o Product per l'accesso all'API.

properties.termsOfServiceUrl

string

URL delle Condizioni per il servizio per l'API. DEVE essere nel formato di un URL.

properties.type

ApiType

Tipo di API.

type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

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

Tipo di API.

Nome Tipo Descrizione
graphql

string

grpc

string

http

string

odata

string

soap

string

websocket

string

ApiUpdateContract

Dettagli del contratto di aggiornamento API.

Nome Tipo Descrizione
properties.apiRevision

string

Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1

properties.apiRevisionDescription

string

Descrizione della revisione dell'API.

properties.apiVersion

string

Indica l'identificatore della versione dell'API se l'API è con versione

properties.apiVersionDescription

string

Descrizione della versione dell'API.

properties.apiVersionSetId

string

Identificatore di risorsa per l'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

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

URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi delle 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 in modo da formare un URL pubblico per questa API.

properties.protocols

Protocol[]

Descrive su quali protocolli è possibile richiamare le operazioni in questa API.

properties.serviceUrl

string

URL assoluto del servizio back-end che implementa questa API.

properties.subscriptionKeyParameterNames

SubscriptionKeyParameterNamesContract

Protocolli su cui viene resa disponibile l'API.

properties.subscriptionRequired

boolean

Specifica se è necessaria una sottoscrizione API o Product per l'accesso all'API.

properties.termsOfServiceUrl

string

URL delle Condizioni per il servizio per l'API. DEVE essere nel formato di un URL.

properties.type

ApiType

Tipo di API.

ApiVersionSetContractDetails

Un set di versioni dell'API contiene la configurazione comune per un set di versioni 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 troverà l'identificatore della versione dell'API in una richiesta HTTP.

AuthenticationSettingsContract

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

Come inviare il token al server.

Nome Tipo Descrizione
authorizationHeader

string

Il token di accesso verrà trasmesso nell'intestazione di autorizzazione usando lo schema Bearer

query

string

Il token di accesso verrà trasmesso come parametri di query.

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorDetail

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

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

OAuth2AuthenticationSettingsContract

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

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

Descrive su quali protocolli è possibile richiamare le operazioni in questa API.

Nome Tipo Descrizione
http

string

https

string

ws

string

wss

string

SubscriptionKeyParameterNamesContract

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

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

Nome Tipo Descrizione
Header

string

La versione dell'API viene passata in un'intestazione HTTP.

Query

string

La versione dell'API viene passata in un parametro di query.

Segment

string

La versione dell'API viene passata in un segmento di percorso.