az apic api definition
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 API definition-opdracht uitvoert. Meer informatie over extensies.
Opdrachten voor het beheren van API-definities in API Center.
Opdracht
| Name | Description | Type | Status |
|---|---|---|---|
| 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 definition create
Maak een nieuwe API-definitie of werk een bestaande API-definitie bij.
az apic api definition create --api-id
--definition-id
--resource-group
--service-name
--title
--version-id
[--description]Voorbeelden
API-definitie maken
az apic api definition create -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"Vereiste parameters
De id van de API.
De id van de API-definitie.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.
De naam van de Azure API Center-service.
De API-versie.
De id van de API-versie.
Optionele parameters
Beschrijving van API-definitie.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
az apic api definition delete
Verwijder de opgegeven API-definitie.
az apic api definition delete [--api-id]
[--definition-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]
[--version-id]
[--yes]Voorbeelden
API-definitie verwijderen
az apic api definition delete -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"Optionele parameters
De id van de API.
De id van de API-definitie.
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.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.
De naam van de Azure API Center-service.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
De id van de API-versie.
Niet vragen om bevestiging.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
az apic api definition export-specification
Hiermee exporteert u de API-specificatie.
az apic api definition export-specification --file-name
[--api-id]
[--definition-id]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--service-name]
[--subscription]
[--version-id]Voorbeelden
Exportspecificatie
az apic api definition export-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id default --file-name filename.jsonVereiste parameters
Naam van het bestand waarnaar de specificatie moet worden geëxporteerd.
Optionele parameters
De id van de API.
De id van de API-definitie.
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.
Wacht niet totdat de langdurige bewerking is voltooid.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.
De naam van de Azure API Center-service.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
De id van de API-versie.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
az apic api definition import-specification
Hiermee importeert u de API-specificatie.
az apic api definition import-specification --format {inline, link}
--specification
--value
[--api-id]
[--definition-id]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--service-name]
[--subscription]
[--version-id]Voorbeelden
Voorbeeld van importspecificatie 1
az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api-2 --version-id 2023-08-01 --definition-id openapi3 --format "inline" --value '{"openapi":"3.0.1","info":{"title":"httpbin.org","description":"API Management facade for a very handy and free online HTTP tool.","version":"1.0"}}' --specification '{"name":"openapi","version":"3.0.0"}'Voorbeeld van importspecificatie 2
az apic api definition import-specification -g api-center-test -n contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json' --specification '{"name":"openapi","version":"3.0.0"}'Vereiste parameters
Indeling van de API-specificatiebron.
Api-specificatiedetails. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.
Waarde van de API-specificatiebron.
Optionele parameters
De id van de API.
De id van de API-definitie.
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.
Wacht niet totdat de langdurige bewerking is voltooid.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.
De naam van de Azure API Center-service.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
De id van de API-versie.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
az apic api definition list
Een verzameling API-definities weergeven.
az apic api definition list --api-id
--resource-group
--service-name
--version-id
[--filter]
[--max-items]
[--next-token]Voorbeelden
API-definities weergeven
az apic api definition list -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01Vereiste parameters
De id van de API.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.
De naam van de Azure API Center-service.
De id van de API-versie.
Optionele parameters
OData-filterparameter.
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.
Token om op te geven waar paginering moet worden gestart. Dit is de tokenwaarde van een eerder afgekapt antwoord.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
az apic api definition show
Details van de API-definitie ophalen.
az apic api definition show [--api-id]
[--definition-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]
[--version-id]Voorbeelden
Details van API-definitie weergeven
az apic api definition show -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"Optionele parameters
De id van de API.
De id van de API-definitie.
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.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.
De naam van de Azure API Center-service.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
De id van de API-versie.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
az apic api definition update
Bestaande API-definitie bijwerken.
az apic api definition update [--add]
[--api-id]
[--definition-id]
[--description]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--remove]
[--resource-group]
[--service-name]
[--set]
[--subscription]
[--title]
[--version-id]Voorbeelden
API-definitie bijwerken
az apic api definition update -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"Optionele parameters
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>.
De id van de API.
De id van de API-definitie.
Beschrijving van API-definitie.
Wanneer u 'set' of 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.
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.
Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list OR --remove propertyToRemove.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.
De naam van de Azure API Center-service.
Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
Titel van API-versie.
De id van de API-versie.
Globale parameters
Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Dit Help-bericht weergeven en afsluiten.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.
Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.
