Udostępnij przez

az apic metadata

  • Odwołanie

Uwaga

Ta dokumentacja jest częścią rozszerzenia apic-extension dla interfejsu wiersza polecenia platformy Azure (wersja 2.57.0 lub nowsza). Rozszerzenie zostanie automatycznie zainstalowane przy pierwszym uruchomieniu polecenia az apic metadata . Dowiedz się więcej o rozszerzeniach.

Polecenia do zarządzania schematami metadanych w Centrum interfejsu API.

Polecenia

Nazwa Opis Typ Stan
az apic metadata create

Utwórz nowy schemat metadanych lub zaktualizuj istniejący schemat metadanych.

 Numer wewnętrzny Ogólna dostępność
az apic metadata delete

Usuń określony schemat metadanych.

 Numer wewnętrzny Ogólna dostępność
az apic metadata export

Eksportuje schemat metadanych.

 Numer wewnętrzny Ogólna dostępność
az apic metadata list

Wyświetlanie listy kolekcji schematów metadanych.

 Numer wewnętrzny Ogólna dostępność
az apic metadata show

Uzyskaj szczegółowe informacje o schemacie metadanych.

 Numer wewnętrzny Ogólna dostępność
az apic metadata update

Zaktualizuj istniejący schemat metadanych.

 Numer wewnętrzny Ogólna dostępność

az apic metadata create

Utwórz nowy schemat metadanych lub zaktualizuj istniejący schemat metadanych.

az apic metadata create --assignments
                        --metadata-schema
                        --resource-group
                        --schema
                        --service
                        [--file-name]

Przykłady

Tworzenie przykładu metadanych 1

az apic metadata create --resource-group api-center-test --service-name contoso --name "test1" --schema '{"type":"string", "title":"First name", "pattern": "^[a-zA-Z0-9]+$"}' --assignments '[{entity:api,required:true,deprecated:false}]'

Tworzenie metadanych — przykład 2

az apic metadata create --resource-group api-center-test --service-name contoso  --name testregion --schema '{"type":"string","title":"testregion","oneOf":[{"const":"Region1","description":""},{"const":"Region2","description":""},{"const":"Region3","description":""}]}' --assignments '[{entity:api,required:true,deprecated:false},{entity:environment,required:true,deprecated:false}]'

Parametry wymagane

--assignments

Definiuje zakres przypisania dla metadanych niestandardowych, np. "[{entity:api,required:true,deprecated:false}]". Dostępne wartości jednostek to: api, deployment, environment. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

--metadata-schema --metadata-schema-name --name

Nazwa schematu metadanych.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--schema

Schemat JSON definiujący typ.

--service --service-name -s

Nazwa usługi API Center.

Parametry opcjonalne

--file-name

Nazwa pliku z pliku zawierającego schemat metadanych.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az apic metadata delete

Usuń określony schemat metadanych.

az apic metadata delete [--ids]
                        [--metadata-schema]
                        [--resource-group]
                        [--service]
                        [--subscription]
                        [--yes]

Przykłady

Usuwanie schematu metadanych

az apic metadata delete --resource-group api-center-test --service-name contoso --name "test1"

Usuwanie schematu

az apic metadata delete -g api-center-test -s contosoeuap --name "approver"

Parametry opcjonalne

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być pełny identyfikator zasobu zawierający wszystkie informacje o argumentach "Identyfikator zasobu". Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

--metadata-schema --metadata-schema-name --name

Nazwa schematu metadanych.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--service --service-name -s

Nazwa usługi API Center.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--yes -y

Nie monituj o potwierdzenie.

wartość domyślna: False
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az apic metadata export

Eksportuje schemat metadanych.

az apic metadata export --assignments {api, deployment, environment}
                        --file-name
                        [--ids]
                        [--name]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--resource-group]
                        [--subscription]

Przykłady

Eksportowanie schematu metadanych przypisanego do interfejsu API

az apic metadata export -g api-center-test -s contosoeuap --assignments api --file-name filename.json

Eksportowanie schematu metadanych przypisanego do wdrożenia

az apic metadata export -g api-center-test -s contosoeuap --assignments deployment --file-name filename.json

Eksportowanie schematu metadanych przypisanego do środowiska

az apic metadata export -g api-center-test -s contosoeuap --assignments environment --file-name filename.json

Parametry wymagane

--assignments

Jednostka, dla którego jest wymagany schemat metadanych.

akceptowane wartości: api, deployment, environment
--file-name

Nazwa pliku, do którego ma być eksportowany schemat metadanych.

Parametry opcjonalne

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być pełny identyfikator zasobu zawierający wszystkie informacje o argumentach "Identyfikator zasobu". Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

--name --service --service-name -s

Nazwa usługi API Center.

--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

akceptowane wartości: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az apic metadata list

Wyświetlanie listy kolekcji schematów metadanych.

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

Przykłady

Schematy listy

az apic metadata list -g api-center-test -s contosoeuap

Parametry wymagane

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--service --service-name -s

Nazwa usługi API Center.

Parametry opcjonalne

--filter

Parametr filtru OData.

--max-items

Łączna liczba elementów do zwrócenia w danych wyjściowych polecenia. Jeśli łączna liczba dostępnych elementów jest większa niż określona wartość, token jest udostępniany w danych wyjściowych polecenia. Aby wznowić stronicowanie, podaj wartość tokenu w --next-token argumencie kolejnego polecenia.

--next-token

Token do określenia, gdzie rozpocząć stronicowanie. Jest to wartość tokenu z wcześniej obciętej odpowiedzi.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az apic metadata show

Uzyskaj szczegółowe informacje o schemacie metadanych.

az apic metadata show [--ids]
                      [--metadata-schema]
                      [--resource-group]
                      [--service]
                      [--subscription]

Przykłady

Pokaż szczegóły schematu 1

az apic metadata show -g api-center-test -s contosoeuap --name approver

Pokaż szczegóły schematu 2

az apic metadata show --resource-group api-center-test --service-name contoso --name "testchoices"

Parametry opcjonalne

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być pełny identyfikator zasobu zawierający wszystkie informacje o argumentach "Identyfikator zasobu". Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

--metadata-schema --metadata-schema-name --name

Nazwa schematu metadanych.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--service --service-name -s

Nazwa usługi API Center.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

az apic metadata update

Zaktualizuj istniejący schemat metadanych.

az apic metadata update [--add]
                        [--assignments]
                        [--file-name]
                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                        [--ids]
                        [--metadata-schema]
                        [--remove]
                        [--resource-group]
                        [--schema]
                        [--service]
                        [--set]
                        [--subscription]

Przykłady

Aktualizowanie schematu

az apic metadata update --resource-group api-center-test --service-name contoso --name "test1" --schema '{"type":"string", "title":"Last name", "pattern": "^[a-zA-Z0-9]+$"}'

Parametry opcjonalne

--add

Dodaj obiekt do listy obiektów, określając pary ścieżki i wartości klucza. Przykład: --add property.listProperty <key=value, string lub ciąg> JSON.

--assignments

Definiuje zakres przypisania dla metadanych niestandardowych, np. "[{entity:api,required:true,deprecated:false}]". Dostępne wartości jednostek to: api, deployment, environment. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

--file-name

Nazwa pliku z pliku zawierającego schemat metadanych.

--force-string

W przypadku używania polecenia "set" lub "add" zachowaj literały ciągu zamiast próbować konwertować na format JSON.

akceptowane wartości: 0, 1, f, false, n, no, t, true, y, yes
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być pełny identyfikator zasobu zawierający wszystkie informacje o argumentach "Identyfikator zasobu". Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

--metadata-schema --metadata-schema-name --name

Nazwa schematu metadanych.

--remove

Usuń właściwość lub element z listy. Przykład: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--schema

Schemat YAML definiujący typ.

--service --service-name -s

Nazwa usługi API Center.

--set

Zaktualizuj obiekt, określając ścieżkę właściwości i wartość do ustawienia. Przykład: --set property1.property2=.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.