Udostępnij przez

az apic api-analysis

  • Wersja zapoznawcza

Uwaga / Notatka

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 api-analysis . Dowiedz się więcej o rozszerzeniach.

Ta grupa poleceń jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Zarządzanie funkcjami analizy interfejsu API usługi Azure API Center.

Polecenia

Nazwa Opis Typ Stan
az apic api-analysis create

Utwórz nową lub zaktualizuj istniejącą konfigurację analizatora interfejsu API.

 Rozszerzenie Prapremiera
az apic api-analysis delete

Usuwanie usuwa konfigurację analizatora interfejsu API.

 Rozszerzenie Prapremiera
az apic api-analysis export-ruleset

Eksportuje zestaw reguł analizatora interfejsu API.

 Rozszerzenie Prapremiera
az apic api-analysis import-ruleset

Importuje zestaw reguł analizatora interfejsu API.

 Rozszerzenie Prapremiera
az apic api-analysis list

Wyświetlanie listy konfiguracji analizatora interfejsu API.

 Rozszerzenie Prapremiera
az apic api-analysis show

Uzyskaj szczegółowe informacje o konfiguracji analizatora interfejsu API.

 Rozszerzenie Prapremiera
az apic api-analysis update

Zaktualizuj nową lub zaktualizuj istniejącą konfigurację analizatora interfejsu API.

 Rozszerzenie Prapremiera

az apic api-analysis create

Wersja zapoznawcza

Grupa poleceń "az apic api-analysis" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Utwórz nową lub zaktualizuj istniejącą konfigurację analizatora interfejsu API.

az apic api-analysis create --analyzer-config-name --config-name
                            --resource-group
                            --service-name
                            [--description]
                            [--filter]
                            [--title]

Przykłady

Tworzenie konfiguracji reguły analizy interfejsu API

az apic api-analysis create -g contoso-resources -n contoso -c spectral-openapi

Parametry wymagane

--analyzer-config-name --config-name -c

Nazwa konfiguracji.

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

--description

Opis konfiguracji analizatora.

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

Filtr analizatora interfejsu API. 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
--title

Tytuł konfiguracji analizatora, np. "Spectral (OpenAPI)".

Właściwość Wartość
Grupa parametrów: Properties 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 polecenia 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 api-analysis delete

Wersja zapoznawcza

Grupa poleceń "az apic api-analysis" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Usuwanie usuwa konfigurację analizatora interfejsu API.

az apic api-analysis delete [--analyzer-config-name --config-name]
                            [--ids]
                            [--resource-group]
                            [--service-name]
                            [--subscription]
                            [--yes]

Przykłady

Usuwanie konfiguracji reguły analizy interfejsu API

az apic api-analysis delete -g contoso-resources -n contoso -c spectral-openapi

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.

--analyzer-config-name --config-name -c

Nazwa konfiguracji.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--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
--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 polecenia 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 api-analysis export-ruleset

Wersja zapoznawcza

Grupa poleceń "az apic api-analysis" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Eksportuje zestaw reguł analizatora interfejsu API.

az apic api-analysis export-ruleset --path
                                    [--analyzer-config-name --config-name]
                                    [--ids]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--resource-group]
                                    [--service-name]
                                    [--subscription]

Przykłady

Eksportowanie zestawu reguł analizy interfejsu API

az apic api-analysis export-ruleset -g contoso-resources -n contoso -c spectral-openapi --path '\path\for\output\files'

Parametry wymagane

--path

Ścieżka folderu do wyodrębnienia plików zestawu reguł.

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.

--analyzer-config-name --config-name -c

Nazwa konfiguracji.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--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
--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 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 polecenia 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 api-analysis import-ruleset

Wersja zapoznawcza

Grupa poleceń "az apic api-analysis" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Importuje zestaw reguł analizatora interfejsu API.

az apic api-analysis import-ruleset --path
                                    [--analyzer-config-name --config-name]
                                    [--ids]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--resource-group]
                                    [--service-name]
                                    [--subscription]

Przykłady

Importowanie zestawu reguł analizy interfejsu API

az apic api-analysis import-ruleset -g contoso-resources -n contoso -c spectral-openapi --path '\path\to\ruleset\folder'

Parametry wymagane

--path

Ścieżka folderu zawierająca pliki zestawu reguł.

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.

--analyzer-config-name --config-name -c

Nazwa konfiguracji.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--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
--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 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 polecenia 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 api-analysis list

Wersja zapoznawcza

Grupa poleceń "az apic api-analysis" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Wyświetlanie listy konfiguracji analizatora interfejsu API.

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

Przykłady

Wyświetlanie listy wszystkich konfiguracji reguł analizy interfejsu API dla usługi

az apic api-analysis list -g contoso-resources -n contoso

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 polecenia 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 api-analysis show

Wersja zapoznawcza

Grupa poleceń "az apic api-analysis" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Uzyskaj szczegółowe informacje o konfiguracji analizatora interfejsu API.

az apic api-analysis show [--analyzer-config-name --config-name]
                          [--ids]
                          [--resource-group]
                          [--service-name]
                          [--subscription]

Przykłady

Pokaż szczegóły konfiguracji reguły analizy interfejsu API

az apic api-analysis show -g contoso-resources -n contoso -c spectral-openapi

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.

--analyzer-config-name --config-name -c

Nazwa konfiguracji.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--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
--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 polecenia 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 api-analysis update

Wersja zapoznawcza

Grupa poleceń "az apic api-analysis" jest w wersji zapoznawczej i jest opracowywana. Poziomy odwołań i pomocy technicznej: https://aka.ms/CLI_refstatus

Zaktualizuj nową lub zaktualizuj istniejącą konfigurację analizatora interfejsu API.

az apic api-analysis update [--add]
                            [--analyzer-config-name --config-name]
                            [--description]
                            [--filter]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--ids]
                            [--remove]
                            [--resource-group]
                            [--service-name]
                            [--set]
                            [--subscription]
                            [--title]

Przykłady

Aktualizowanie konfiguracji reguły analizy interfejsu API

az apic api-analysis update -g contoso-resources -n contoso -c spectral-openapi

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
--analyzer-config-name --config-name -c

Nazwa konfiguracji.

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

Opis konfiguracji analizatora.

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

Filtr analizatora interfejsu API. 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
--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

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

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

Tytuł konfiguracji analizatora, np. "Spectral (OpenAPI)".

Właściwość Wartość
Grupa parametrów: Properties 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