Condividi tramite

az apim backend

Gestire Gestione API di Azure back-end.

Comandi

Nome Descrizione Tipo Status
az apim backend create

Creare o aggiornare un back-end di Gestione API.

 Nucleo GA
az apim backend delete

Eliminare un back-end di Gestione API.

 Nucleo GA
az apim backend list

Elencare i back-end di Gestione API.

 Nucleo GA
az apim backend show

Visualizzare i dettagli di un back-end di Gestione API.

 Nucleo GA
az apim backend update

Aggiornare un back-end di Gestione API.

 Nucleo GA

az apim backend create

Modifica

Creare o aggiornare un back-end di Gestione API.

az apim backend create --backend-id
                       --protocol {http, soap}
                       --resource-group
                       --service-name
                       --url
                       [--acquire-policy-token]
                       [--change-reference]
                       [--description]
                       [--if-match]

Esempio

Creare un back-end.

az apim backend create --service-name MyApim -g MyResourceGroup --backend-id MyBackendId --url https://mybackend.com --protocol http

Parametri necessari

--backend-id

Nome univoco per il back-end da creare o aggiornare.

Deve essere univoco nell'istanza corrente del servizio Gestione API.

Proprietà Valore
Gruppo di parametri: Backend Arguments
--protocol

Protocollo usato per comunicare con il servizio back-end.

Proprietà Valore
Valori accettati: http, soap
--resource-group -g

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

--service-name -n

Nome dell'istanza del servizio Gestione API.

--url

URL del servizio back-end.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--description

Descrizione del back-end. Può includere tag di formattazione HTML.

--if-match

ETag dell'Ente.

Parametri globali
--debug

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

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Proprietà Valore
Valore predefinito: False

az apim backend delete

Modifica

Eliminare un back-end di Gestione API.

az apim backend delete --backend-id
                       --resource-group
                       --service-name
                       [--acquire-policy-token]
                       [--change-reference]
                       [--if-match]
                       [--yes]

Esempio

Eliminare un back-end in un'istanza di Gestione API.

az apim backend delete --resource-group MyResourceGroup --service-name MyServiceName --backend-id MyBackendId

Parametri necessari

--backend-id

Identificatore del back-end.

Proprietà Valore
Gruppo di parametri: Backend Arguments
--resource-group -g

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

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--if-match

ETag dell'Ente.

--yes -y

Non richiedere conferma.

Proprietà Valore
Valore predefinito: False
Parametri globali
--debug

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

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Proprietà Valore
Valore predefinito: False

az apim backend list

Modifica

Elencare i back-end di Gestione API.

az apim backend list --resource-group
                     --service-name

Esempio

Elencare tutti i back-end in un'istanza di Gestione API.

az apim backend list --resource-group MyResourceGroup --service-name MyServiceName

Parametri necessari

--resource-group -g

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

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri globali
--debug

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

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Proprietà Valore
Valore predefinito: False

az apim backend show

Modifica

Visualizzare i dettagli di un back-end di Gestione API.

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

Esempio

Visualizzare i dettagli di un back-end in un'istanza di Gestione API.

az apim backend show --resource-group MyResourceGroup --service-name MyServiceName --backend-id MyBackendId

Parametri necessari

--backend-id

Identificatore del back-end.

Proprietà Valore
Gruppo di parametri: Backend Arguments
--resource-group -g

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

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri globali
--debug

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

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Proprietà Valore
Valore predefinito: False

az apim backend update

Modifica

Aggiornare un back-end di Gestione API.

az apim backend update --backend-id
                       --resource-group
                       --service-name
                       [--acquire-policy-token]
                       [--add]
                       [--change-reference]
                       [--description]
                       [--force-string]
                       [--if-match]
                       [--protocol {http, soap}]
                       [--remove]
                       [--set]
                       [--url]

Esempio

Aggiornare un back-end.

az apim backend update --service-name MyApim -g MyResourceGroup --backend-id MyBackendId --url https://mynewbackend.com

Parametri necessari

--backend-id

Nome univoco del back-end da aggiornare.

Deve essere univoco nell'istanza corrente del servizio Gestione API.

Proprietà Valore
Gruppo di parametri: Backend Arguments
--resource-group -g

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

--service-name -n

Nome dell'istanza del servizio Gestione API.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--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>.

Proprietà Valore
Gruppo di parametri: Generic Update Arguments
Valore predefinito: []
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--description

Descrizione del back-end. Può includere tag di formattazione HTML.

--force-string

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

Proprietà Valore
Gruppo di parametri: Generic Update Arguments
Valore predefinito: False
--if-match

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

--protocol

Protocollo usato per comunicare con il servizio back-end. I valori possibili includono: http, soap.

Proprietà Valore
Valori accettati: http, soap
--remove

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

Proprietà Valore
Gruppo di parametri: Generic Update Arguments
Valore predefinito: []
--set

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

Proprietà Valore
Gruppo di parametri: Generic Update Arguments
Valore predefinito: []
--url

URL del servizio back-end.

Parametri globali
--debug

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

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Proprietà Valore
Valore predefinito: False