Delen via

az apic api deployment

Note

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 deployment opdracht uitvoert. Meer informatie over uitbreidingen.

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

Opdracht

Name Description Type Status
az apic api deployment create

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

 Extension GA
az apic api deployment delete

API-implementatie verwijderen.

 Extension GA
az apic api deployment list

Een verzameling API-implementaties weergeven.

 Extension GA
az apic api deployment show

Details van de API-implementatie ophalen.

 Extension GA
az apic api deployment update

Bestaande API-implementatie bijwerken.

 Extension GA

az apic api deployment create

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

az apic api deployment create --api-id
                              --definition-id
                              --deployment-id
                              --environment-id
                              --resource-group
                              --server
                              --service-name
                              --title
                              [--custom-properties]
                              [--description]

Voorbeelden

Deployment aanmaken

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '{"runtimeUri":["https://example.com"]}'

Implementatie maken met behulp van het JSON-bestand van de server

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '@server.json'

Vereiste parameters

--api-id

De id van de API.

--definition-id

Resource-id voor de definitie van het API-centrum.

Eigenschap Waarde
Parametergroep: Properties Arguments
--deployment-id

De id van de API-implementatie.

--environment-id

Resource-id van de API centerd environment.

Eigenschap Waarde
Parametergroep: Properties Arguments
--resource-group -g

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

--server

Server biedt ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap Waarde
Parametergroep: Properties Arguments
--service-name -n

De naam van de Azure API Center-service.

--title

Titel van implementatie.

Eigenschap Waarde
Parametergroep: Properties Arguments

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--custom-properties

De aangepaste metagegevens die zijn gedefinieerd voor API-catalogusentiteiten. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap Waarde
Parametergroep: Properties Arguments
--description

Beschrijving van de implementatie.

Eigenschap Waarde
Parametergroep: Properties Arguments
Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

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

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

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

az apic api deployment delete

API-implementatie verwijderen.

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

Voorbeelden

API-implementatie verwijderen

az apic api deployment delete -g api-center-test -n contoso --deployment-id production --api-id echo-api

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--api-id

De id van de API.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--deployment-id

De id van de API-implementatie.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--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. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--resource-group -g

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--service-name -n

De naam van de Azure API Center-service.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--subscription

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--yes -y

Niet vragen om bevestiging.

Eigenschap Waarde
Default value: False
Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

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

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

--verbose

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

Eigenschap Waarde
Default value: False

az apic api deployment list

Een verzameling API-implementaties weergeven.

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

Voorbeelden

API-implementaties vermelden

az apic api deployment list -g api-center-test -n contoso --api-id echo-api

Vereiste parameters

--api-id

De id van de API.

--resource-group -g

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

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--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 argument van een volgende opdracht.

Eigenschap Waarde
Parametergroep: Pagination Arguments
--next-token

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

Eigenschap Waarde
Parametergroep: Pagination Arguments
Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

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

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

--subscription

Naam of id van 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.

Eigenschap Waarde
Default value: False

az apic api deployment show

Details van de API-implementatie ophalen.

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

Voorbeelden

Api-implementatiedetails weergeven

az apic api deployment show -g api-center-test -n contoso --deployment-id production --api-id echo-api

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--api-id

De id van de API.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--deployment-id

De id van de API-implementatie.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--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. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--resource-group -g

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--service-name -n

De naam van de Azure API Center-service.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--subscription

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

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

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

--verbose

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

Eigenschap Waarde
Default value: False

az apic api deployment update

Bestaande API-implementatie bijwerken.

az apic api deployment update [--add]
                              [--api-id]
                              [--custom-properties]
                              [--definition-id]
                              [--deployment-id]
                              [--description]
                              [--environment-id]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--server]
                              [--service-name]
                              [--set]
                              [--subscription]
                              [--title]

Voorbeelden

API-implementatie bijwerken

az apic api deployment update -g api-center-test -n contoso --deployment-id production --title "Production deployment" --api-id echo-api

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--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 or JSON string>.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
--api-id

De id van de API.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--custom-properties

De aangepaste metagegevens die zijn gedefinieerd voor API-catalogusentiteiten. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap Waarde
Parametergroep: Properties Arguments
--definition-id

Resource-id voor definitie van servicebereik.

Eigenschap Waarde
Parametergroep: Properties Arguments
--deployment-id

De id van de API-implementatie.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--description

Beschrijving van de implementatie.

Eigenschap Waarde
Parametergroep: Properties Arguments
--environment-id

Resource-id van de omgeving met servicebereik.

Eigenschap Waarde
Parametergroep: Properties Arguments
--force-string

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

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Geaccepteerde waarden: 0, 1, f, false, n, no, t, true, y, yes
--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. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--remove

Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list <indexToRemove> OF --remove propertyToRemove.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
--resource-group -g

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--server

Server biedt ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

Eigenschap Waarde
Parametergroep: Properties Arguments
--service-name -n

De naam van de Azure API Center-service.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--set

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

Eigenschap Waarde
Parametergroep: Generic Update Arguments
--subscription

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--title

Title.

Eigenschap Waarde
Parametergroep: Properties Arguments
Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

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

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

--verbose

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

Eigenschap Waarde
Default value: False