Delen via

az apic

  • Referentie

Notitie

Deze verwijzing maakt deel uit van de extensie apic-extension voor de Azure CLI (versie 2.57.0 of hoger). De extensie installeert automatisch de eerste keer dat u een az apic-opdracht uitvoert. Meer informatie over extensies.

Azure API Center-services beheren.

Opdracht

Name Description Type Status
az apic api

Opdrachten voor het beheren van API's in API Center.

 Toestel GA
az apic api create

Registreer een nieuwe API of werk een bestaande API bij.

 Toestel GA
az apic api definition

Opdrachten voor het beheren van API-definities in API Center.

 Toestel GA
az apic api definition create

Maak een nieuwe API-definitie of werk een bestaande API-definitie bij.

 Toestel GA
az apic api definition delete

Verwijder de opgegeven API-definitie.

 Toestel GA
az apic api definition export-specification

Hiermee exporteert u de API-specificatie.

 Toestel GA
az apic api definition import-specification

Hiermee importeert u de API-specificatie.

 Toestel GA
az apic api definition list

Een verzameling API-definities weergeven.

 Toestel GA
az apic api definition show

Details van de API-definitie ophalen.

 Toestel GA
az apic api definition update

Bestaande API-definitie bijwerken.

 Toestel GA
az apic api delete

Verwijder de opgegeven API.

 Toestel GA
az apic api deployment

Opdrachten voor het beheren van API-implementaties in API Center.

 Toestel GA
az apic api deployment create

Maak een nieuwe API-implementatie of werk een bestaande API-implementatie bij.

 Toestel GA
az apic api deployment delete

API-implementatie verwijderen.

 Toestel GA
az apic api deployment list

Een verzameling API-implementaties weergeven.

 Toestel GA
az apic api deployment show

Details van de API-implementatie ophalen.

 Toestel GA
az apic api deployment update

Bestaande API-implementatie bijwerken.

 Toestel GA
az apic api list

Een verzameling API's weergeven.

 Toestel GA
az apic api register

Registreert een nieuwe API met versie, definitie en bijbehorende implementaties met behulp van het specificatiebestand als de bron van waarheid. Voorlopig ondersteunen we alleen de OpenAPI JSON/YAML-indeling.

 Toestel Preview uitvoeren
az apic api show

Details van de API ophalen.

 Toestel GA
az apic api update

Bestaande API bijwerken.

 Toestel GA
az apic api version

Opdrachten voor het beheren van API-versies in API Center.

 Toestel GA
az apic api version create

Maak een nieuwe API-versie of werk een bestaande API-versie bij.

 Toestel GA
az apic api version delete

Verwijder de opgegeven API-versie.

 Toestel GA
az apic api version list

Een verzameling API-versies weergeven.

 Toestel GA
az apic api version show

Details van de API-versie ophalen.

 Toestel GA
az apic api version update

Bestaande API-versie bijwerken.

 Toestel GA
az apic create

Hiermee maakt u een exemplaar of werkt u een bestaand exemplaar van een Azure API Center-service bij.

 Toestel GA
az apic delete

Hiermee verwijdert u een exemplaar van een Azure API Center-service.

 Toestel GA
az apic environment

Opdrachten voor het beheren van omgevingen in API Center.

 Toestel GA
az apic environment create

Maak een nieuwe omgeving of werk een bestaande omgeving bij.

 Toestel GA
az apic environment delete

De omgeving verwijderen.

 Toestel GA
az apic environment list

Een verzameling omgevingen weergeven.

 Toestel GA
az apic environment show

Details van de omgeving ophalen.

 Toestel GA
az apic environment update

Bestaande omgeving bijwerken.

 Toestel GA
az apic import-from-apim

Hiermee importeert u API's uit een Azure API Management-service-exemplaar.

 Toestel GA
az apic list

Toont Azure API Center-services binnen een Azure-abonnement.

 Toestel GA
az apic metadata

Opdrachten voor het beheren van metagegevensschema's in API Center.

 Toestel GA
az apic metadata create

Maak een nieuw metagegevensschema of werk een bestaand metagegevensschema bij.

 Toestel GA
az apic metadata delete

Verwijder het opgegeven metagegevensschema.

 Toestel GA
az apic metadata export

Hiermee exporteert u het metagegevensschema.

 Toestel GA
az apic metadata list

Een verzameling metagegevensschema's weergeven.

 Toestel GA
az apic metadata show

Details van het metagegevensschema ophalen.

 Toestel GA
az apic metadata update

Het bestaande metagegevensschema bijwerken.

 Toestel GA
az apic show

Details van een Azure API Center-service-exemplaar weergeven.

 Toestel GA
az apic update

Een exemplaar van een Azure API Center-service bijwerken.

 Toestel GA

az apic create

Hiermee maakt u een exemplaar of werkt u een bestaand exemplaar van een Azure API Center-service bij.

az apic create --name
               --resource-group
               [--identity]
               [--location]
               [--tags]

Voorbeelden

Servicevoorbeeld 1 maken

az apic create -g contoso-resources -n contoso -l eastus

Servicevoorbeeld 2 maken

az apic create --resource-group contoso-resources --name contoso --location eastus

Vereiste parameters

--name -n

De naam van de API Center-service.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Optionele parameters

--identity

De beheerde service-identiteiten die zijn toegewezen aan deze resource. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

--location -l

De geografische locatie waar de resource zich bevindt wanneer deze niet is opgegeven, wordt de locatie van de resourcegroep gebruikt.

--tags

Resourcetags. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az apic delete

Hiermee verwijdert u een exemplaar van een Azure API Center-service.

az apic delete [--ids]
               [--name]
               [--resource-group]
               [--subscription]
               [--yes]

Voorbeelden

Service verwijderen

az apic delete -n contoso -g contoso-resources

Optionele parameters

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

--name -n

De naam van de API Center-service.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--yes -y

Niet vragen om bevestiging.

Default value: False
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az apic import-from-apim

Hiermee importeert u API's uit een Azure API Management-service-exemplaar.

az apic import-from-apim --apim-apis
                         --apim-name
                         [--apim-resource-group]
                         [--apim-subscription]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--resource-group]
                         [--service-name]
                         [--subscription]

Voorbeelden

Alle API's uit APIM in dezelfde resourcegroep importeren

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis *

Geselecteerde API's importeren uit APIM in dezelfde resourcegroep

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis [echo,foo]

Alle API's uit APIM importeren in een ander abonnement en een andere resourcegroep

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-subscription 00000000-0000-0000-0000-000000000000 --apim-resource-group apim-rg --apim-name contoso-apim --apim-apis *

Vereiste parameters

--apim-apis

De API's die moeten worden geïmporteerd. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

--apim-name

De naam van het bron-APIM-exemplaar.

Optionele parameters

--apim-resource-group

De resourcegroep van het bron-APIM-exemplaar.

--apim-subscription

De abonnements-id van het bron-APIM-exemplaar.

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--service-name -n

De naam van de Azure API Center-service.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az apic list

Toont Azure API Center-services binnen een Azure-abonnement.

Er is een bekend probleem waarbij alle resources onder een abonnement niet werken. Vermeld resources per resourcegroep.

az apic list [--max-items]
             [--next-token]
             [--resource-group]

Voorbeelden

Services weergeven in resourcegroep

az apic list -g contoso-resources

Optionele parameters

--max-items

Totaal aantal items dat moet worden geretourneerd in de uitvoer van de opdracht. Als het totale aantal beschikbare items groter is dan de opgegeven waarde, wordt een token opgegeven in de uitvoer van de opdracht. Als u paginering wilt hervatten, geeft u de tokenwaarde op in --next-token het argument van een volgende opdracht.

--next-token

Token om op te geven waar paginering moet worden gestart. Dit is de tokenwaarde van een eerder afgekapt antwoord.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az apic show

Details van een Azure API Center-service-exemplaar weergeven.

az apic show [--ids]
             [--name]
             [--resource-group]
             [--subscription]

Voorbeelden

Servicedetails weergeven

az apic show -g contoso-resources -n contoso

Optionele parameters

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

--name -n

De naam van de API Center-service.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az apic update

Een exemplaar van een Azure API Center-service bijwerken.

az apic update [--add]
               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
               [--identity]
               [--ids]
               [--name]
               [--remove]
               [--resource-group]
               [--set]
               [--subscription]
               [--tags]

Voorbeelden

Servicedetails bijwerken

az apic update -g contoso-resources -n contoso

Optionele parameters

--add

Voeg een object toe aan een lijst met objecten door een pad- en sleutelwaardeparen op te geven. Voorbeeld: --add property.listProperty <key=value, string of JSON string>.

--force-string

Wanneer u 'set' of 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.

Geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--identity

De beheerde service-identiteiten die zijn toegewezen aan deze resource. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. Geef de argumenten --id's of andere resource-id's op.

--name -n

De naam van de API Center-service.

--remove

Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list OR --remove propertyToRemove.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--set

Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--tags

Resourcetags. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.