az apic metadata

Note

Ta dokumentacja jest częścią rozszerzenia apic-extension dla interfejsu wiersza polecenia platformy Azure (wersja 2.57.0 lub nowsza). Rozszerzenie automatycznie zainstaluje polecenie 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.	Extension	ogólna dostępność
az apic metadata delete	Usuń określony schemat metadanych.	Extension	ogólna dostępność
az apic metadata export	Eksportuje schemat metadanych.	Extension	ogólna dostępność
az apic metadata list	Wyświetlanie listy kolekcji schematów metadanych.	Extension	ogólna dostępność
az apic metadata show	Uzyskaj szczegółowe informacje o schemacie metadanych.	Extension	ogólna dostępność
az apic metadata update	Zaktualizuj istniejący schemat metadanych.	Extension	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-name
                        --resource-group
                        --schema
                        --service-name

Przykłady

Tworzenie przykładu metadanych 1

az apic metadata create --resource-group api-center-test --service-name contoso --metadata-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  --metadata-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}]'

Przykład tworzenia metadanych przy użyciu schematu i przypisań plików json

az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test" --schema '@schema.json' --assignments '@assignments.json'

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.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--metadata-name

Nazwa schematu metadanych.

--resource-group -g

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

--schema

Schemat JSON definiujący typ.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--service-name -n

Nazwa usługi Azure API Center.

Parametry globalne

--debug

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

Właściwość	Wartość
Domyślna wartość:	False

--help -h

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

--only-show-errors

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

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--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 az account set -s NAME_OR_ID.

--verbose

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

Właściwość	Wartość
Domyślna wartość:	False

az apic metadata delete

Usuń określony schemat metadanych.

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

Przykłady

Usuwanie schematu metadanych

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

Usuwanie schematu

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

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--metadata-name

Nazwa schematu metadanych.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--resource-group -g

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--service-name -n

Nazwa usługi Azure API Center.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--subscription

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--yes -y

Nie monituj o potwierdzenie.

Właściwość	Wartość
Domyślna wartość:	False

Parametry globalne

--debug

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

Właściwość	Wartość
Domyślna wartość:	False

--help -h

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

--only-show-errors

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

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Właściwość	Wartość
Domyślna wartość:	False

az apic metadata export

Eksportuje schemat metadanych.

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

Przykłady

Eksportowanie schematu metadanych przypisanego do interfejsu API

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

Eksportowanie schematu metadanych przypisanego do wdrożenia

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

Eksportowanie schematu metadanych przypisanego do środowiska

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

Eksportowanie tylko niestandardowego schematu metadanych

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

Parametry wymagane

--assignments

Jednostka, dla którego jest wymagany schemat metadanych.

Właściwość	Wartość
Grupa parametrów:	Payload Arguments
Dopuszczalne wartości:	api, deployment, environment

--file-name

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

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--custom-metadata-only

Eksportowanie tylko metadanych niestandardowych.

Właściwość	Wartość
Dopuszczalne wartości:	0, 1, f, false, n, no, t, true, y, yes

--ids

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--no-wait

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

Właściwość	Wartość
Dopuszczalne 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 az configure --defaults group=<name>.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--service-name -n

Nazwa usługi API Center.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--subscription

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

Parametry globalne

--debug

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

Właściwość	Wartość
Domyślna wartość:	False

--help -h

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

--only-show-errors

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

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Właściwość	Wartość
Domyślna wartość:	False

az apic metadata list

Wyświetlanie listy kolekcji schematów metadanych.

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

Przykłady

Schematy listy

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

Parametry wymagane

--resource-group -g

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

--service-name -n

Nazwa usługi Azure API Center.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--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 argumentu kolejnego polecenia.

Właściwość	Wartość
Grupa parametrów:	Pagination Arguments

--next-token

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

Właściwość	Wartość
Grupa parametrów:	Pagination Arguments

Parametry globalne

--debug

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

Właściwość	Wartość
Domyślna wartość:	False

--help -h

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

--only-show-errors

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

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--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 az account set -s NAME_OR_ID.

--verbose

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

Właściwość	Wartość
Domyślna wartość:	False

az apic metadata show

Uzyskaj szczegółowe informacje o schemacie metadanych.

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

Przykłady

Pokaż szczegóły schematu 1

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

Pokaż szczegóły schematu 2

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

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--ids

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--metadata-name

Nazwa schematu metadanych.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--resource-group -g

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--service-name -n

Nazwa usługi Azure API Center.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--subscription

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

Parametry globalne

--debug

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

Właściwość	Wartość
Domyślna wartość:	False

--help -h

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

--only-show-errors

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

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Właściwość	Wartość
Domyślna wartość:	False

az apic metadata update

Zaktualizuj istniejący schemat metadanych.

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

Przykłady

Aktualizowanie schematu

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

Aktualizowanie schematu przy użyciu pliku json schematu

az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '@schema.json'

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

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

Właściwość	Wartość
Grupa parametrów:	Generic Update Arguments

--assignments

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--force-string

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

Właściwość	Wartość
Grupa parametrów:	Generic Update Arguments
Dopuszczalne wartości:	0, 1, f, false, n, no, t, true, y, yes

--ids

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--metadata-name

Nazwa schematu metadanych.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--remove

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

Właściwość	Wartość
Grupa parametrów:	Generic Update Arguments

--resource-group -g

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--schema

Schemat YAML definiujący typ.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--service-name -n

Nazwa usługi Azure API Center.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--set

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

Właściwość	Wartość
Grupa parametrów:	Generic Update Arguments

--subscription

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

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

Parametry globalne

--debug

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

Właściwość	Wartość
Domyślna wartość:	False

--help -h

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

--only-show-errors

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

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Właściwość	Wartość
Domyślna wartość:	False

Sprzężenie zwrotne

Czy ta strona była pomocna?

Udostępnij przez

az apic metadata

Polecenia

az apic metadata create

Przykłady

Parametry wymagane

az apic metadata delete

Przykłady

Parametry opcjonalne

az apic metadata export

Przykłady

Parametry wymagane

Parametry opcjonalne

az apic metadata list

Przykłady

Parametry wymagane

Parametry opcjonalne

az apic metadata show

Przykłady

Parametry opcjonalne

az apic metadata update

Przykłady

Parametry opcjonalne

Sprzężenie zwrotne