az apim api
Gestire l'API Gestione API di Azure.
Comandi
| Nome | Descrizione | Tipo | Stato |
|---|---|---|---|
| az apim api create |
Creare un'API Gestione API. |
Memoria centrale | Disponibilità generale |
| az apim api delete |
Eliminare un'API Gestione API. |
Memoria centrale | Disponibilità generale |
| az apim api export |
Esportare un'API Gestione API. |
Memoria centrale | Disponibilità generale |
| az apim api import |
Importare un'API Gestione API. |
Memoria centrale | Disponibilità generale |
| az apim api list |
Elencare Gestione API API. |
Memoria centrale | Disponibilità generale |
| az apim api operation |
Gestire le operazioni api di Azure Gestione API. |
Memoria centrale | Disponibilità generale |
| az apim api operation create |
Crea una nuova operazione nell'API. |
Memoria centrale | Disponibilità generale |
| az apim api operation delete |
Elimina l'operazione specificata nell'API. |
Memoria centrale | Disponibilità generale |
| az apim api operation list |
Elencare una raccolta di operazioni per l'API specificata. |
Memoria centrale | Disponibilità generale |
| az apim api operation show |
Ottiene i dettagli dell'operazione API specificata dal relativo identificatore. |
Memoria centrale | Disponibilità generale |
| az apim api operation update |
Aggiornamenti i dettagli dell'operazione nell'API specificata dal relativo identificatore. |
Memoria centrale | Disponibilità generale |
| az apim api release |
Gestire la versione dell'API Gestione API di Azure. |
Memoria centrale | Disponibilità generale |
| az apim api release create |
Crea una nuova versione per l'API. |
Memoria centrale | Disponibilità generale |
| az apim api release delete |
Elimina la versione specificata nell'API. |
Memoria centrale | Disponibilità generale |
| az apim api release list |
Elenca tutte le versioni di un'API. |
Memoria centrale | Disponibilità generale |
| az apim api release show |
Restituisce i dettagli di una versione dell'API. |
Memoria centrale | Disponibilità generale |
| az apim api release update |
Aggiornamenti i dettagli della versione dell'API specificata dal relativo identificatore. |
Memoria centrale | Disponibilità generale |
| az apim api revision |
Gestire la revisione dell'API Gestione API di Azure. |
Memoria centrale | Disponibilità generale |
| az apim api revision create |
Creare una revisione dell'API. |
Memoria centrale | Disponibilità generale |
| az apim api revision list |
Elenca tutte le revisioni di un'API. |
Memoria centrale | Disponibilità generale |
| az apim api schema |
Gestire lo schema dell'API Gestione API di Azure. |
Memoria centrale | Disponibilità generale |
| az apim api schema create |
Creare uno schema API Gestione API. |
Memoria centrale | Disponibilità generale |
| az apim api schema delete |
Eliminare uno schema API Gestione API. |
Memoria centrale | Disponibilità generale |
| az apim api schema get-etag |
Ottenere l'etag di uno schema API Gestione API. |
Memoria centrale | Disponibilità generale |
| az apim api schema list |
Elencare Gestione API schema API. |
Memoria centrale | Disponibilità generale |
| az apim api schema show |
Visualizzare i dettagli di uno schema API Gestione API. |
Memoria centrale | Disponibilità generale |
| az apim api schema wait |
Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione di uno schema apim. |
Memoria centrale | Disponibilità generale |
| az apim api show |
Visualizzare i dettagli di un'API Gestione API. |
Memoria centrale | Disponibilità generale |
| az apim api update |
Aggiornare un'API Gestione API. |
Memoria centrale | Disponibilità generale |
| az apim api versionset |
Gestire il set di versioni dell'API Gestione API di Azure. |
Memoria centrale | Disponibilità generale |
| az apim api versionset create |
Crea un set di versioni api. |
Memoria centrale | Disponibilità generale |
| az apim api versionset delete |
Elimina un set di versioni dell'API specifico. |
Memoria centrale | Disponibilità generale |
| az apim api versionset list |
Elenca una raccolta di set di versioni dell'API nell'istanza del servizio specificata. |
Memoria centrale | Disponibilità generale |
| az apim api versionset show |
Ottiene i dettagli del set di versioni api specificato dal relativo identificatore. |
Memoria centrale | Disponibilità generale |
| az apim api versionset update |
Aggiornamenti i dettagli dell'API VersionSet specificato dal relativo identificatore. |
Memoria centrale | Disponibilità generale |
| az apim api wait |
Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione di apim. |
Memoria centrale | Disponibilità generale |
az apim api create
Creare un'API Gestione API.
az apim api create --api-id
--display-name
--path
--resource-group
--service-name
[--api-type {graphql, http, soap, websocket}]
[--authorization-scope]
[--authorization-server-id]
[--bearer-token-sending-methods]
[--description]
[--no-wait]
[--open-id-provider-id]
[--protocols {http, https, ws, wss}]
[--service-url]
[--subscription-key-header-name]
[--subscription-key-query-param-name]
[--subscription-key-required]
[--subscription-required {false, true}]Esempio
Creare un'API di base.
az apim api create --service-name MyApim -g MyResourceGroup --api-id MyApi --path '/myapi' --display-name 'My API'Parametri necessari
Nome univoco dell'API da creare.
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.
Nome visualizzato dell'API da creare.
Percorso dell'API.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.
Nome dell'istanza del servizio Gestione API.
Parametri facoltativi
Tipo di API.
Specifica l'ambito delle operazioni OAuth.
Specifica l'ID server di autorizzazione OAuth.
Specifica i metodi di invio per il token di connessione.
Descrizione dell'API. Può includere tag di formattazione HTML.
Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.
Specifica il valore openid nell'impostazione di autenticazione.
Descrive su quali protocolli è possibile richiamare le operazioni in questa API.
URL assoluto del servizio back-end che implementa questa API. Non può contenere più di 2000 caratteri.
Specifica il nome dell'intestazione della chiave di sottoscrizione.
Specifica il nome del parametro della stringa di query della chiave di sottoscrizione.
Specifica se la chiave di sottoscrizione è necessaria durante la chiamata a questa API, true - L'API viene inclusa solo nei prodotti chiusi, false- L'API è inclusa solo nei prodotti aperti, null. Esiste una combinazione di prodotti.
Se true, l'API richiede una chiave di sottoscrizione nelle richieste.
Parametri globali
Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
Visualizza questo messaggio della guida ed esce.
Mostra solo gli errori, eliminando gli avvisi.
Formato di output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apim api delete
Eliminare un'API Gestione API.
az apim api delete --api-id
--resource-group
--service-name
[--delete-revisions]
[--if-match]
[--no-wait]
[--yes]Parametri necessari
Identificatore 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.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.
Nome dell'istanza del servizio Gestione API.
Parametri facoltativi
Eliminare tutte le revisioni dell'API.
ETag dell'entità.
Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.
Indica che non è richiesta la conferma.
Parametri globali
Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
Visualizza questo messaggio della guida ed esce.
Mostra solo gli errori, eliminando gli avvisi.
Formato di output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apim api export
Esportare un'API Gestione API.
az apim api export --api-id
--ef {OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl}
--resource-group
--service-name
[--file-path]Esempio
Esportare un'API Gestione API in un file o restituire una risposta contenente un collegamento dell'esportazione.
az apim api export -g MyResourceGroup --service-name MyApim --api-id MyApi --export-format OpenApiJson --file-path pathParametri necessari
Identificatore 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. Modello regex: ^[^*#&+:<>?] +$.
Specificare il formato dell'API di esportazione.
Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
Nome dell'istanza del servizio Gestione API.
Parametri facoltativi
Percorso del file specificato per esportare l'API.
Parametri globali
Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
Visualizza questo messaggio della guida ed esce.
Mostra solo gli errori, eliminando gli avvisi.
Formato di output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apim api import
Importare un'API Gestione API.
az apim api import --path
--resource-group
--service-name
--specification-format {GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl}
[--api-id]
[--api-revision]
[--api-type {graphql, http, soap, websocket}]
[--api-version]
[--api-version-set-id]
[--description]
[--display-name]
[--no-wait]
[--protocols {http, https, ws, wss}]
[--service-url]
[--soap-api-type]
[--specification-path]
[--specification-url]
[--subscription-key-header-name]
[--subscription-key-query-param-name]
[--subscription-required {false, true}]
[--wsdl-endpoint-name]
[--wsdl-service-name]Esempio
Importare un'API Gestione API da un file o un URL
az apim api import -g MyResourceGroup --service-name MyApim --path MyApi --specification-url https://MySpecificationURL --specification-format OpenApiJsonParametri necessari
Obbligatorio. URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi delle risorse all'interno dell'istanza del servizio Gestione API.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.
Nome dell'istanza del servizio Gestione API.
Specificare il formato dell'API importata.
Parametri facoltativi
Identificatore 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.
Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1.
Tipo di API.
Descrive la versione dell'API. Se si aggiunge una versione a un'API senza versione, verrà creata automaticamente una versione originale e risponderà sull'URL predefinito.
Descrive il set di versioni da usare con l'API.
Descrizione dell'API. Può includere tag di formattazione HTML.
Nome visualizzato dell'API.
Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.
Descrive i protocolli che possono essere richiamati da una o più operazioni in questa API.
URL assoluto del servizio back-end che implementa questa API. Non può contenere più di 2000 caratteri.
Tipo di API quando il formato di file è WSDL.
Percorso del file specificato per importare l'API.
URL specificato per importare l'API.
Specifica il nome dell'intestazione della chiave di sottoscrizione.
Specifica il nome del parametro della stringa di query della chiave di sottoscrizione.
Se true, l'API richiede una chiave di sottoscrizione nelle richieste.
Nome locale dell'endpoint WSDL (porta) da importare.
Nome locale del servizio WSDL da importare.
Parametri globali
Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
Visualizza questo messaggio della guida ed esce.
Mostra solo gli errori, eliminando gli avvisi.
Formato di output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apim api list
Elencare Gestione API API.
az apim api list --resource-group
--service-name
[--filter-display-name]
[--skip]
[--top]Parametri necessari
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.
Nome dell'istanza del servizio Gestione API.
Parametri facoltativi
Filtro delle API in base a displayName.
Numero di record da ignorare.
Numero di record da restituire.
Parametri globali
Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
Visualizza questo messaggio della guida ed esce.
Mostra solo gli errori, eliminando gli avvisi.
Formato di output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apim api show
Visualizzare i dettagli di un'API Gestione API.
az apim api show --api-id
--resource-group
--service-nameParametri necessari
Identificatore 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.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.
Nome dell'istanza del servizio Gestione API.
Parametri globali
Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
Visualizza questo messaggio della guida ed esce.
Mostra solo gli errori, eliminando gli avvisi.
Formato di output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apim api update
Aggiornare un'API Gestione API.
az apim api update --api-id
--resource-group
--service-name
[--add]
[--api-type {graphql, http, soap, websocket}]
[--description]
[--display-name]
[--force-string]
[--if-match]
[--no-wait]
[--path]
[--protocols {http, https, ws, wss}]
[--remove]
[--service-url]
[--set]
[--subscription-key-header-name]
[--subscription-key-query-param-name]
[--subscription-required {false, true}]
[--tags]Esempio
Creare un'API di base.
az apim api update --service-name MyApim -g MyResourceGroup --api-id MyApi --description fooParametri necessari
Nome univoco dell'API da creare.
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.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.
Nome dell'istanza del servizio Gestione API.
Parametri facoltativi
Aggiungere un oggetto a un elenco di oggetti specificando un percorso e coppie chiave-valore. Esempio: --add property.listProperty <key=value, string or JSON string>.
Tipo di API.
Descrizione dell'API. Può includere tag di formattazione HTML.
Nome API. Deve contenere da 1 a 300 caratteri.
Quando si usa 'set' o 'add', mantenere i valori letterali stringa anziché tentare di eseguire la conversione in JSON.
ETag dell'entità. Non obbligatorio durante la creazione di un'entità, ma necessario durante l'aggiornamento di un'entità. Il valore predefinito è Nessuno.
Indica che non è necessario attendere il termine dell'operazione a esecuzione prolungata.
Obbligatorio. URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi delle risorse all'interno dell'istanza del servizio Gestione API.
Descrive su quali protocolli è possibile richiamare le operazioni in questa API.
Rimuovere una proprietà o un elemento da un elenco. Esempio: --remove property.list <indexToRemove> OR --remove propertyToRemove.
URL assoluto del servizio back-end che implementa questa API. Non può contenere più di 2000 caratteri.
Aggiornare un oggetto specificando un percorso di proprietà e un valore da impostare. Esempio: --set property1.property2=<value>.
Specifica il nome dell'intestazione della chiave di sottoscrizione.
Specifica il nome del parametro della stringa di query della chiave di sottoscrizione.
Se true, l'API richiede una chiave di sottoscrizione nelle richieste.
Tag separati da spazi: key[=value] [key[=value] ...]. Usare "" per cancellare i tag esistenti.
Parametri globali
Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
Visualizza questo messaggio della guida ed esce.
Mostra solo gli errori, eliminando gli avvisi.
Formato di output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
az apim api wait
Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione di apim.
az apim api wait --api-id
--name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]Esempio
Posizionare l'interfaccia della riga di comando in uno stato di attesa fino a quando non viene soddisfatta una condizione di apim. (generato automaticamente)
az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroupParametri necessari
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. Obbligatorio.
Nome dell'istanza del servizio Gestione API.
Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.
Parametri facoltativi
Attendere fino a quando non viene creato con 'provisioningState' in 'Succeeded'.
Attendere che la condizione soddisfi una query JMESPath personalizzata. Ad esempio provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Attendere l'eliminazione.
Attendere che la risorsa esista.
Intervallo di polling in secondi.
Attesa massima in secondi.
Attendere fino a quando non viene aggiornato con provisioningState in 'Succeeded'.
Parametri globali
Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.
Visualizza questo messaggio della guida ed esce.
Mostra solo gli errori, eliminando gli avvisi.
Formato di output.
Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.
Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.
Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.
Commenti e suggerimenti
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedere https://aka.ms/ContentUserFeedback.
Invia e visualizza il feedback per