az apim api schema

  • Referentie

Azure API Management API-schema's beheren.

Opdracht

Name Description Type Status
az apim api schema create

Maak een API Management API-schema.

 Basis GA
az apim api schema delete

Een API Management API-schema verwijderen.

 Basis GA
az apim api schema get-etag

Haal een etag op van een API Management API-schema.

 Basis GA
az apim api schema list

Api Management API-schema's vermelden.

 Basis GA
az apim api schema show

Details van een API Management API-schema weergeven.

 Basis GA
az apim api schema wait

Plaats de CLI in een wachtstatus totdat aan een voorwaarde van een APIM API-schema is voldaan.

 Basis GA

az apim api schema create

Bewerken

Maak een API Management API-schema.

az apim api schema create --api-id
                          --resource-group
                          --schema-id
                          --schema-type
                          --service-name
                          [--no-wait]
                          [--resource-type]
                          [--schema-content]
                          [--schema-name]
                          [--schema-path]

Voorbeelden

Maak een API-schema.

az apim api schema create --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId --schema-type schemaType --schema-path schemaFilePath

Vereiste parameters

--api-id

Unieke naam van de API waarvoor het schema moet worden gemaakt.

API-revisie-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.

--resource-group -g

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

--schema-id

Unieke naam van het API-schema dat moet worden gemaakt.

Schema-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.

--schema-type

Schematype (bijvoorbeeld application/json, application/vnd.ms-azure-apim.graphql.schema).

Moet een geldig mediatype zijn dat wordt gebruikt in een Content-Type-header zoals gedefinieerd in rfc 2616. Mediatype van het schemadocument.

--service-name -n

De naam van het API Management-service-exemplaar.

Optionele parameters

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

standaardwaarde: False
--resource-type

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'.

--schema-content

Json-tekenreeks met escape-tekenreeks die het document definieert dat het schema vertegenwoordigt.

Geef --schema-path of --schema-content niet beide op.

--schema-name

De naam van de schemaresource.

--schema-path

Bestandspad dat is opgegeven om het schema van de API te importeren.

Geef --schema-path of --schema-content niet beide op.

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
standaardwaarde: 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 apim api schema delete

Bewerken

Een API Management API-schema verwijderen.

az apim api schema delete --api-id
                          --resource-group
                          --schema-id
                          --service-name
                          [--if-match]
                          [--no-wait]
                          [--yes]

Voorbeelden

een API-schema verwijderen.

az apim api schema delete --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

Vereiste parameters

--api-id

API-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.

--resource-group -g

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

--schema-id

Schema-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.

--service-name -n

De naam van het API Management-service-exemplaar.

Optionele parameters

--if-match

ETag van de entiteit.

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

standaardwaarde: False
--yes -y

Niet vragen om bevestiging.

standaardwaarde: 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
standaardwaarde: 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 apim api schema get-etag

Bewerken

Haal een etag op van een API Management API-schema.

az apim api schema get-etag --api-id
                            --resource-group
                            --schema-id
                            --service-name

Voorbeelden

haal een schematiteitstag op.

az apim api schema get-etag --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

Vereiste parameters

--api-id

API-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.

--resource-group -g

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

--schema-id

Schema-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.

--service-name -n

De naam van het API Management-service-exemplaar.

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
standaardwaarde: 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 apim api schema list

Bewerken

Api Management API-schema's vermelden.

az apim api schema list --api-id
                        --resource-group
                        --service-name
                        [--filter-display-name]
                        [--skip]
                        [--top]

Voorbeelden

Haal een lijst op met schema's die zijn gekoppeld aan een API-id.

az apim api schema list --service-name MyApim -g MyResourceGroup --api-id MyApi

Vereiste parameters

--api-id

API-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.

--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 het API Management-service-exemplaar.

Optionele parameters

--filter-display-name

Filter van API's op displayName.

--skip

Het aantal records dat moet worden overgeslagen.

--top

Het aantal te retourneren records.

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
standaardwaarde: 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 apim api schema show

Bewerken

Details van een API Management API-schema weergeven.

az apim api schema show --api-id
                        --resource-group
                        --schema-id
                        --service-name

Voorbeelden

Haal een API-schema op.

az apim api schema show --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

Vereiste parameters

--api-id

API-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.

--resource-group -g

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

--schema-id

Schema-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.

--service-name -n

De naam van het API Management-service-exemplaar.

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
standaardwaarde: 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 apim api schema wait

Bewerken

Plaats de CLI in een wachtstatus totdat aan een voorwaarde van een APIM API-schema is voldaan.

az apim api schema wait --api-id
                        --name
                        --resource-group
                        --schema-id
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--timeout]
                        [--updated]

Voorbeelden

Plaats de CLI in een wachtstatus totdat aan een voorwaarde van een APIM API-schema wordt voldaan.

az apim api schema wait --created --api-id MyApi --name MyApim --schema-id schemaId -g MyResourceGroup

Vereiste parameters

--api-id

API-revisie-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is. Vereist.

--name -n

De naam van het api management-service-exemplaar.

--resource-group -g

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

--schema-id

Schema-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Vereist.

Optionele parameters

--created

Wacht totdat u 'provisioningState' hebt gemaakt bij 'Succeeded'.

standaardwaarde: False
--custom

Wacht tot de voorwaarde voldoet aan een aangepaste JMESPath-query. Bijvoorbeeld provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wacht totdat deze is verwijderd.

standaardwaarde: False
--exists

Wacht tot de resource bestaat.

standaardwaarde: False
--interval

Polling-interval in seconden.

standaardwaarde: 30
--timeout

Maximale wachttijd in seconden.

standaardwaarde: 3600
--updated

Wacht totdat deze is bijgewerkt met provisioningState op 'Succeeded'.

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