az apim api

Riferimento

Gestire l'API Gestione API di Azure.

Comandi

Nome	Descrizione	Tipo	Status
az apim api create	Creare un'API di Gestione API.	Nucleo	GA
az apim api delete	Eliminare un'API di Gestione API.	Nucleo	GA
az apim api export	Esportare un'API di Gestione API.	Nucleo	GA
az apim api import	Importare un'API di Gestione API.	Nucleo	GA
az apim api list	Elencare le API di Gestione API.	Nucleo	GA
az apim api operation	Gestire le operazioni api di Gestione API di Azure.	Nucleo	GA
az apim api operation create	Crea una nuova operazione nell'API.	Nucleo	GA
az apim api operation delete	Elimina l'operazione specificata nell'API.	Nucleo	GA
az apim api operation list	Elencare una raccolta di operazioni per l'API specificata.	Nucleo	GA
az apim api operation show	Ottiene i dettagli dell'operazione API specificata dal relativo identificatore.	Nucleo	GA
az apim api operation update	Aggiorna i dettagli dell'operazione nell'API specificata dal relativo identificatore.	Nucleo	GA
az apim api release	Gestire la versione dell'API Gestione API di Azure.	Nucleo	GA
az apim api release create	Crea una nuova versione per l'API.	Nucleo	GA
az apim api release delete	Elimina la versione specificata nell'API.	Nucleo	GA
az apim api release list	Elenca tutte le versioni di un'API.	Nucleo	GA
az apim api release show	Restituisce i dettagli di una versione dell'API.	Nucleo	GA
az apim api release update	Aggiorna i dettagli della versione dell'API specificata dal relativo identificatore.	Nucleo	GA
az apim api revision	Gestire la revisione dell'API gestione API di Azure.	Nucleo	GA
az apim api revision create	Creare una revisione dell'API.	Nucleo	GA
az apim api revision list	Elenca tutte le revisioni di un'API.	Nucleo	GA
az apim api schema	Gestire gli schemi API di Gestione API di Azure.	Nucleo	GA
az apim api schema create	Creare uno schema api di Gestione API.	Nucleo	GA
az apim api schema delete	Eliminare uno schema api di Gestione API.	Nucleo	GA
az apim api schema get-etag	Ottenere l'etag di uno schema api di Gestione API.	Nucleo	GA
az apim api schema list	Elencare gli schemi api di Gestione API.	Nucleo	GA
az apim api schema show	Visualizzare i dettagli di uno schema api di Gestione API.	Nucleo	GA
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.	Nucleo	GA
az apim api show	Visualizzare i dettagli di un'API di Gestione API.	Nucleo	GA
az apim api update	Aggiornare un'API di Gestione API.	Nucleo	GA
az apim api versionset	Gestire il set di versioni dell'API Gestione API di Azure.	Nucleo	GA
az apim api versionset create	Crea un set di versioni api.	Nucleo	GA
az apim api versionset delete	Elimina un set di versioni dell'API specifico.	Nucleo	GA
az apim api versionset list	Elenca una raccolta di set di versioni dell'API nell'istanza del servizio specificata.	Nucleo	GA
az apim api versionset show	Ottiene i dettagli del set di versioni api specificato dal relativo identificatore.	Nucleo	GA
az apim api versionset update	Aggiorna i dettagli dell'API VersionSet specificato dal relativo identificatore.	Nucleo	GA
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.	Nucleo	GA

az apim api create

Modifica

Creare un'API di 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

--api-id

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.

--display-name

Nome visualizzato dell'API da creare.

--path

Percorso dell'API.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri facoltativi

--api-type

Tipo di API.

Valori accettati: graphql, http, soap, websocket

--authorization-scope

Specifica l'ambito delle operazioni OAuth.

--authorization-server-id

Specifica l'ID server di autorizzazione OAuth.

--bearer-token-sending-methods

Specifica i metodi di invio per il token di connessione.

--description

Descrizione dell'API. Può includere tag di formattazione HTML.

--no-wait

Non attendere il completamento dell'operazione a esecuzione prolungata.

Valore predefinito: False

--open-id-provider-id

Specifica il valore openid nell'impostazione di autenticazione.

--protocols

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

Valori accettati: http, https, ws, wss

--service-url

URL assoluto del servizio back-end che implementa questa API. Non può contenere più di 2000 caratteri.

--subscription-key-header-name

Specifica il nome dell'intestazione della chiave di sottoscrizione.

--subscription-key-query-param-name

Specifica il nome del parametro della stringa di query della chiave di sottoscrizione.

--subscription-key-required

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.

--subscription-required

Se true, l'API richiede una chiave di sottoscrizione nelle richieste.

Valori accettati: false, true

Valore predefinito: False

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato dell'output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc

Valore predefinito: json

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az apim api delete

Modifica

Eliminare un'API di Gestione API.

az apim api delete --api-id
                   --resource-group
                   --service-name
                   [--delete-revisions]
                   [--if-match]
                   [--no-wait]
                   [--yes]

Parametri necessari

--api-id

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.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri facoltativi

--delete-revisions

Eliminare tutte le revisioni dell'API.

--if-match

ETag dell'entità.

--no-wait

Non attendere il completamento dell'operazione a esecuzione prolungata.

Valore predefinito: False

--yes -y

Non richiedere conferma.

Valore predefinito: False

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato dell'output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc

Valore predefinito: json

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az apim api export

Modifica

Esportare un'API di Gestione API.

az apim api export --api-id
                   --ef --export-format {OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl}
                   --resource-group
                   --service-name
                   [--file-path]

Esempio

Esportare un'API di 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 path

Parametri necessari

--api-id

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: ^[^*#&+:<>?]+$.

--ef --export-format

Specificare il formato dell'API di esportazione.

Valori accettati: OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl

--resource-group -g

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri facoltativi

--file-path -f

Percorso del file specificato per esportare l'API.

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato dell'output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc

Valore predefinito: json

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az apim api import

Modifica

Importare un'API di 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 di 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 OpenApiJson

Parametri necessari

--path

Obbligatorio. URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi di risorse all'interno dell'istanza del servizio Gestione API.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

--service-name -n

Nome dell'istanza del servizio Gestione API.

--specification-format

Specificare il formato dell'API importata.

Valori accettati: GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

Parametri facoltativi

--api-id

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.

--api-revision

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

--api-type

Tipo di API.

Valori accettati: graphql, http, soap, websocket

--api-version

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.

--api-version-set-id

Descrive il set di versioni da usare con l'API.

--description

Descrizione dell'API. Può includere tag di formattazione HTML.

--display-name

Nome visualizzato dell'API.

--no-wait

Non attendere il completamento dell'operazione a esecuzione prolungata.

Valore predefinito: False

--protocols

Descrive i protocolli che possono essere richiamati da una o più operazioni in questa API.

Valori accettati: http, https, ws, wss

--service-url

URL assoluto del servizio back-end che implementa questa API. Non può contenere più di 2000 caratteri.

--soap-api-type

Tipo di API quando il formato di file è WSDL.

--specification-path

Percorso del file specificato per importare l'API.

--specification-url

URL specificato per importare l'API.

--subscription-key-header-name

Specifica il nome dell'intestazione della chiave di sottoscrizione.

--subscription-key-query-param-name

Specifica il nome del parametro della stringa di query della chiave di sottoscrizione.

--subscription-required

Se true, l'API richiede una chiave di sottoscrizione nelle richieste.

Valori accettati: false, true

--wsdl-endpoint-name

Nome locale dell'endpoint WSDL (porta) da importare.

--wsdl-service-name

Nome locale del servizio WSDL da importare.

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato dell'output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc

Valore predefinito: json

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az apim api list

Modifica

Elencare le API di Gestione API.

az apim api list --resource-group
                 --service-name
                 [--filter-display-name]
                 [--skip]
                 [--top]

Parametri necessari

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri facoltativi

--filter-display-name

Filtro delle API in base a displayName.

--skip

Numero di record da ignorare.

--top

Numero di record da restituire.

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato dell'output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc

Valore predefinito: json

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az apim api show

Modifica

Visualizzare i dettagli di un'API di Gestione API.

az apim api show --api-id
                 --resource-group
                 --service-name

Parametri necessari

--api-id

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.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

--service-name

Nome dell'istanza del servizio Gestione API.

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato dell'output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc

Valore predefinito: json

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az apim api update

Modifica

Aggiornare un'API di 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 foo

Parametri necessari

--api-id

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.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri facoltativi

--add

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>.

Valore predefinito: []

--api-type

Tipo di API.

Valori accettati: graphql, http, soap, websocket

--description

Descrizione dell'API. Può includere tag di formattazione HTML.

--display-name

Nome API. Deve contenere da 1 a 300 caratteri.

--force-string

Quando si usa 'set' o 'add', mantenere i valori letterali stringa anziché tentare di eseguire la conversione in JSON.

Valore predefinito: False

--if-match

ETag dell'entità. Non obbligatorio durante la creazione di un'entità, ma necessario durante l'aggiornamento di un'entità. Il valore predefinito è Nessuno.

--no-wait

Non attendere il completamento dell'operazione a esecuzione prolungata.

Valore predefinito: False

--path

Obbligatorio. URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi di risorse all'interno dell'istanza del servizio Gestione API.

--protocols

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

Valori accettati: http, https, ws, wss

--remove

Rimuovere una proprietà o un elemento da un elenco. Esempio: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Valore predefinito: []

--service-url

URL assoluto del servizio back-end che implementa questa API. Non può contenere più di 2000 caratteri.

--set

Aggiornare un oggetto specificando un percorso di proprietà e un valore da impostare. Esempio: --set property1.property2=<value>.

Valore predefinito: []

--subscription-key-header-name

Specifica il nome dell'intestazione della chiave di sottoscrizione.

--subscription-key-query-param-name

Specifica il nome del parametro della stringa di query della chiave di sottoscrizione.

--subscription-required

Se true, l'API richiede una chiave di sottoscrizione nelle richieste.

Valori accettati: false, true

--tags

Tag separati da spazi: key[=value] [key[=value] ...]. Usare "" per cancellare i tag esistenti.

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato dell'output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc

Valore predefinito: json

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

az apim api wait

Modifica

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 MyResourceGroup

Parametri necessari

--api-id

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.

--name -n

Nome dell'istanza del servizio Gestione API.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito usando az configure --defaults group=<name>.

Parametri facoltativi

--created

Attendere fino a quando non viene creato con 'provisioningState' in 'Succeeded'.

Valore predefinito: False

--custom

Attendere che la condizione soddisfi una query JMESPath personalizzata. Ad esempio provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Attendere l'eliminazione.

Valore predefinito: False

--exists

Attendere che la risorsa esista.

Valore predefinito: False

--interval

Intervallo di polling in secondi.

Valore predefinito: 30

--timeout

Attesa massima in secondi.

Valore predefinito: 3600

--updated

Attendere fino a quando non viene aggiornato con provisioningState in 'Succeeded'.

Valore predefinito: False

Parametri globali

--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato dell'output.

Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc

Valore predefinito: json

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la posizione predefinito usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Condividi tramite

az apim api

Comandi

az apim api create

Esempio

Parametri necessari

Parametri facoltativi

az apim api delete

Parametri necessari

Parametri facoltativi

az apim api export

Esempio

Parametri necessari

Parametri facoltativi

az apim api import

Esempio

Parametri necessari

Parametri facoltativi

az apim api list

Parametri necessari

Parametri facoltativi

az apim api show

Parametri necessari

az apim api update

Esempio

Parametri necessari

Parametri facoltativi

az apim api wait

Esempio

Parametri necessari

Parametri facoltativi