Udostępnij przez

az neon postgres project

Note

Ta dokumentacja jest częścią rozszerzenia neonu dla interfejsu wiersza polecenia platformy Azure (wersja 2.75.0 lub nowsza). Rozszerzenie zostanie automatycznie zainstalowane przy pierwszym uruchomieniu polecenia az neon postgres project . Dowiedz się więcej o rozszerzeniach.

Zarządzaj projektami Neon, w tym listami, tworzeniem, aktualizowaniem, usuwaniem i pobieraniem informacji o projekcie.

Polecenia

Nazwa Opis Typ Stan
az neon postgres project create

Utwórz nowy zasób projektu Neon na platformie Azure.

 Extension ogólna dostępność
az neon postgres project delete

Usuń istniejący zasób projektu Neon na platformie Azure.

 Extension ogólna dostępność
az neon postgres project get-connection-uri

Pobierz identyfikator URI połączenia dla określonej bazy danych Neon Postgres.

 Extension ogólna dostępność
az neon postgres project list

Wyświetl listę wszystkich projektów Neon skojarzonych z określoną organizacją Neon.

 Extension ogólna dostępność
az neon postgres project show

Pobierz szczegóły określonego zasobu projektu Neon.

 Extension ogólna dostępność
az neon postgres project update

Zaktualizuj właściwości istniejącego zasobu projektu Neon na platformie Azure.

 Extension ogólna dostępność

az neon postgres project create

Utwórz nowy zasób projektu Neon na platformie Azure.

az neon postgres project create --organization-name
                                --resource-group
                                [--branch]
                                [--name --project-name]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--pg-version]
                                [--region]

Przykłady

Tworzenie projektu Neon

az neon postgres project create --resource-group rgneon --organization-name neon-org --project-name neon-project --region eastus2 --pg-version 17 --branch "{branch-name:main, role-name:owner_role,database-name:neondb}"

Parametry wymagane

--organization-name

Nazwa organizacji Neon. Jeśli wartość jest pusta, zostanie wyświetlony monit z tty.

--resource-group -g

Nazwa grupy zasobów platformy Azure.

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.

--branch

Właściwości Gałąź projektu. 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
--name --project-name -n

Nazwa projektu Neon.

Właściwość Wartość
Domyślna wartość: Default-Project
--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
--pg-version

Wersja bazy danych PostgreSQL dla bazy danych Neon z wartością domyślną 17.

Właściwość Wartość
Grupa parametrów: Properties Arguments
Domyślna wartość: 17
--region

Region, w którym jest tworzony projekt.

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 neon postgres project delete

Usuń istniejący zasób projektu Neon na platformie Azure.

az neon postgres project delete [--ids]
                                [--organization-name]
                                [--project-id]
                                [--resource-group]
                                [--subscription]
                                [--yes]

Przykłady

Usuń projekt neonowy

az neon postgres project delete --resource-group rgneon --organization-name org-cli-test --project-id old-frost-16758796

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

Nazwa organizacji Neon. Jeśli wartość jest pusta, zostanie wyświetlony monit z tty.

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

Identyfikator projektu Neon.

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

Nazwa grupy zasobów platformy Azure.

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 neon postgres project get-connection-uri

Pobierz identyfikator URI połączenia dla określonej bazy danych Neon Postgres.

az neon postgres project get-connection-uri [--branch-id]
                                            [--database-name]
                                            [--endpoint-id]
                                            [--ids]
                                            [--is-pooled {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--organization-name]
                                            [--project-id]
                                            [--project-name]
                                            [--resource-group]
                                            [--role-name]
                                            [--subscription]

Przykłady

Uzyskiwanie identyfikatora URI połączenia z bazą danych

az neon postgres project get-connection-uri --resource-group rgneon --organization-name test-org --project-name entity-name --project-id old-frost-16758796 --branch-id br-spring-field-a8vje3tr --database-name neondb --role-name owner_role --endpoint-id ep-purple-voice-a84wphbw --is-pooled false

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.

--branch-id

Identyfikator gałęzi skojarzony z tym połączeniem.

Właściwość Wartość
Grupa parametrów: ConnectionUriParameters Arguments
--database-name

Nazwa bazy danych skojarzona z tym połączeniem.

Właściwość Wartość
Grupa parametrów: ConnectionUriParameters Arguments
--endpoint-id

Identyfikator punktu końcowego z tym połączeniem.

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

Wskazuje, czy połączenie jest w puli.

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

Nazwa organizacji Neon. Jeśli wartość jest pusta, zostanie wyświetlony monit z tty.

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

Identyfikator projektu skojarzony z tym połączeniem.

Właściwość Wartość
Grupa parametrów: ConnectionUriParameters Arguments
--project-name

Nazwa projektu Neon.

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

Nazwa grupy zasobów platformy Azure.

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

Nazwa roli używana do uwierzytelniania.

Właściwość Wartość
Grupa parametrów: ConnectionUriParameters 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 neon postgres project list

Wyświetl listę wszystkich projektów Neon skojarzonych z określoną organizacją Neon.

az neon postgres project list --organization-name
                              --resource-group
                              [--max-items]
                              [--next-token]

Przykłady

Wyświetlanie listy projektów neonowych w organizacji

az neon postgres project list --resource-group rgneon --organization-name org-cli-test

Parametry wymagane

--organization-name

Nazwa organizacji Neon. Jeśli wartość jest pusta, zostanie wyświetlony monit z tty.

--resource-group -g

Nazwa grupy zasobów platformy Azure.

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.

--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 neon postgres project show

Pobierz szczegóły określonego zasobu projektu Neon.

az neon postgres project show [--ids]
                              [--organization-name]
                              [--project-id]
                              [--resource-group]
                              [--subscription]

Przykłady

Pokaż deatils projektu neonowego

az neon postgres project show --resource-group rgneon --organization-name org-cli-test --project-id old-frost-16758796

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

Nazwa organizacji Neon. Jeśli wartość jest pusta, zostanie wyświetlony monit z tty.

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

Identyfikator projektu Neon.

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

Nazwa grupy zasobów platformy Azure.

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 neon postgres project update

Zaktualizuj właściwości istniejącego zasobu projektu Neon na platformie Azure.

az neon postgres project update [--add]
                                [--branch]
                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                [--ids]
                                [--name --project-name]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--organization-name]
                                [--pg-version]
                                [--region]
                                [--remove]
                                [--resource-group]
                                [--set]
                                [--subscription]

Przykłady

Neon Project Update

az neon postgres project update --resource-group rgneon --organization-name neon-org --project-name neon-project --region eastus2 --pg-version 18

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

Właściwości Gałąź projektu. Jest to opcjonalne wsparcie skróconej składni, 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
--name --project-name -n

Nazwa projektu Neon.

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

Nazwa organizacji Neon. Jeśli wartość jest pusta, zostanie wyświetlony monit z tty.

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

Wersja bazy danych Postgres dla projektu.

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

Region, w którym jest tworzony projekt.

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

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