az apic api

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 API-opdracht uitvoert. Meer informatie over extensies.

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

Opdracht

Name	Description	Type	Status
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 api create

Registreer een nieuwe API of werk een bestaande API bij.

az apic api create --api-id
                   --resource-group
                   --service-name
                   --title
                   --type {graphql, grpc, rest, soap, webhook, websocket}
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--license]
                   [--summary]

Voorbeelden

API maken

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST

API maken met aangepaste eigenschappen

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{"public-facing":true}'

Vereiste parameters

--api-id

De id van de API.

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

--title

API-titel.

--type

Type of API.

Geaccepteerde waarden: graphql, grpc, rest, soap, webhook, websocket

Optionele parameters

--contacts

De contactgegevens voor de API. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

--custom-properties

De aangepaste metagegevens die zijn gedefinieerd voor API-catalogusentiteiten. Ondersteuning voor json-file en yaml-file.

--description

Beschrijving van de API.

--external-documentation

Aanvullende, externe documentatie voor de API. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

--license

De licentiegegevens voor de API. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

--summary

Korte beschrijving van de API.

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 api delete

Verwijder de opgegeven API.

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

Voorbeelden

API verwijderen

az apic api delete -g contoso-resources -n contoso --api-id echo-api

Optionele parameters

--api-id

De id van de API.

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

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

--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 api list

Een verzameling API's weergeven.

az apic api list --resource-group
                 --service-name
                 [--filter]
                 [--max-items]
                 [--next-token]

Voorbeelden

API's weergeven

az apic api list -g contoso-resources -n contoso

API's weergeven met filter

az apic api list -g contoso-resources -n contoso --filter "kind eq 'rest'"

Vereiste parameters

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

Optionele parameters

--filter

OData-filterparameter.

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

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 api register

Preview

Deze opdracht is in preview en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

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.

az apic api register --api-location
                     --resource-group
                     --service-name
                     [--environment-id]

Voorbeelden

Registreer de API door het specificatiebestand op te geven.

az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.yml" --environment-id public

Vereiste parameters

--api-location -l

Locatie van spec-bestand.

--resource-group -g

Naam van de resourcegroep.

--service-name -n

ApiCenter-catalogus of servicenaam.

Optionele parameters

--environment-id

Id van omgeving die eerder is gemaakt.

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 api show

Details van de API ophalen.

az apic api show [--api-id]
                 [--ids]
                 [--resource-group]
                 [--service-name]
                 [--subscription]

Voorbeelden

API-details weergeven

az apic api show -g contoso-resources -n contoso --api-id echo-api

Optionele parameters

--api-id

De id van de API.

--ids

--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 api update

Bestaande API bijwerken.

az apic api update [--add]
                   [--api-id]
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                   [--ids]
                   [--license]
                   [--remove]
                   [--resource-group]
                   [--service-name]
                   [--set]
                   [--subscription]
                   [--summary]
                   [--title]
                   [--type {graphql, grpc, rest, soap, webhook, websocket}]

Voorbeelden

API bijwerken

az apic api update -g contoso-resources -n contoso --api-id echo-api --summary "Basic REST API service"

Aangepaste eigenschappen bijwerken

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '{"public-facing":true}'

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

--api-id

De id van de API.

--contacts

De contactgegevens voor de API. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

--custom-properties

De aangepaste metagegevens die zijn gedefinieerd voor API-catalogusentiteiten. Ondersteuning voor json-file en yaml-file.

--description

Beschrijving van de API.

--external-documentation

Aanvullende, externe documentatie voor de API. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

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

--ids

--license

De licentiegegevens voor de API. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

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

--service-name -n

De naam van de Azure API Center-service.

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

--summary

Korte beschrijving van de API.

--title

API-titel.

--type

Type of API.

Geaccepteerde waarden: graphql, grpc, rest, soap, webhook, websocket

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.

Delen via

az apic api

Opdracht

az apic api create

Voorbeelden

Vereiste parameters

Optionele parameters

az apic api delete

Voorbeelden

Optionele parameters

az apic api list

Voorbeelden

Vereiste parameters

Optionele parameters

az apic api register

Voorbeelden

Vereiste parameters

Optionele parameters

az apic api show

Voorbeelden

Optionele parameters

az apic api update

Voorbeelden

Optionele parameters

Aanvullende resources