Delen via

az apic environment

  • 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-omgevingsopdracht uitvoert. Meer informatie over extensies.

Opdrachten voor het beheren van omgevingen in API Center.

Opdracht

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

Maak een nieuwe omgeving of werk een bestaande omgeving bij.

az apic environment create --environment-id
                           --resource-group
                           --service-name
                           --title
                           --type {development, production, staging, testing}
                           [--custom-properties]
                           [--description]
                           [--onboarding]
                           [--server]

Voorbeelden

Omgeving maken

az apic environment create -g api-center-test -n contosoeuap --environment-id public --title "Public cloud" --type "development"

Vereiste parameters

--environment-id

De id van de omgeving.

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

Omgevingstitel.

--type

Omgevingstype.

Geaccepteerde waarden: development, production, staging, testing

Optionele parameters

--custom-properties

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

--description

Beschrijving van de omgeving.

--onboarding

Geef onboardingdocumentatie op met betrekking tot uw omgeving, bijvoorbeeld {developerPortalUri:['https://developer.contoso.com'],instructies:'instructions markdown'} ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

--server

Servergegevens van de omgeving. 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 environment delete

De omgeving verwijderen.

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

Voorbeelden

Omgeving verwijderen

az apic environment delete -g api-center-test -n contosoeuap --environment-id public

Optionele parameters

--environment-id

De id van de omgeving.

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

Een verzameling omgevingen weergeven.

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

Voorbeelden

Lijst met omgevingen weergeven

az apic environment list -g api-center-test -n contosoeuap

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

Details van de omgeving ophalen.

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

Voorbeelden

Omgevingsgegevens weergeven

az apic environment show -g api-center-test -n contosoeuap --environment-id public

Optionele parameters

--environment-id

De id van de omgeving.

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

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

Bestaande omgeving bijwerken.

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

Voorbeelden

Omgeving bijwerken

az apic environment update -g api-center-test -n contosoeuap --environment-id public --title "Public cloud"

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

--custom-properties

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

--description

Beschrijving.

--environment-id

De id van de omgeving.

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

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.

--onboarding

{developerPortalUri:['https://developer.contoso.com'],instructies:'instructions markdown'} Ondersteuning voor shorthand-syntax, 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>.

--server

Servergegevens van de omgeving. Ondersteuning voor shorthand-syntaxis, json-file en yaml-file. Probeer '??' om meer weer te geven.

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

--title

Omgevingstitel.

--type

Omgevingstype.

Geaccepteerde waarden: development, production, staging, testing
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.