ResourceGroupsOperations Klasa
Ostrzeżenie
NIE tworzy wystąpienia tej klasy bezpośrednio.
Zamiast tego należy uzyskać dostęp do następujących operacji za pomocą polecenia
<xref:resource_groups> Atrybut.
- Dziedziczenie
-
builtins.objectResourceGroupsOperations
Konstruktor
ResourceGroupsOperations(*args, **kwargs)
Metody
begin_delete |
Usuwa grupę zasobów. Po usunięciu grupy zasobów wszystkie jej zasoby również zostaną usunięte. Usunięcie grupy zasobów powoduje usunięcie wszystkich wdrożeń szablonu i aktualnie przechowywanych operacji. |
begin_export_template |
Przechwytuje określoną grupę zasobów jako szablon. |
check_existence |
Sprawdza, czy grupa zasobów istnieje. |
create_or_update |
Tworzy lub aktualizuje grupę zasobów. |
get |
Pobiera grupę zasobów. |
list |
Pobiera wszystkie grupy zasobów dla subskrypcji. |
update |
Aktualizacje grupę zasobów. Grupy zasobów można zaktualizować za pomocą prostej operacji PATCH na adres grupy. Format żądania jest taki sam jak w przypadku tworzenia grupy zasobów. Jeśli pole jest nieokreślone, bieżąca wartość zostanie zachowana. |
begin_delete
Usuwa grupę zasobów.
Po usunięciu grupy zasobów wszystkie jej zasoby również zostaną usunięte. Usunięcie grupy zasobów powoduje usunięcie wszystkich wdrożeń szablonu i aktualnie przechowywanych operacji.
begin_delete(resource_group_name: str, force_deletion_types: str | None = None, **kwargs: Any) -> LROPoller[None]
Parametry
- resource_group_name
- str
Nazwa grupy zasobów do usunięcia. W nazwie jest uwzględniana wielkość liter. Wymagane.
- force_deletion_types
- str
Typy zasobów, które chcesz wymusić usunięcie. Obecnie obsługiwane są tylko następujące elementy: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets. Wartość domyślna to Brak.
- cls
- callable
Niestandardowy typ lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
- continuation_token
- str
Token kontynuacji umożliwiający ponowne uruchomienie narzędzia poller z zapisanego stanu.
- polling
- bool lub PollingMethod
Domyślnie metoda sondowania będzie mieć wartość ARMPolling. Przekaż wartość False dla tej operacji, aby nie sondować lub przekazać własny zainicjowany obiekt sondowania dla osobistej strategii sondowania.
- polling_interval
- int
Domyślny czas oczekiwania między dwoma sondami dla operacji LRO, jeśli nie ma Retry-After nagłówka.
Zwraca
Wystąpienie LROPoller zwracające wartość None lub wynik cls(response)
Typ zwracany
Wyjątki
begin_export_template
Przechwytuje określoną grupę zasobów jako szablon.
begin_export_template(resource_group_name: str, parameters: _models.ExportTemplateRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ResourceGroupExportResult]
Parametry
- resource_group_name
- str
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter. Wymagane.
- parameters
- ExportTemplateRequest lub IO
Parametry eksportowania szablonu. Jest typem ExportTemplateRequest lub typem we/wy. Wymagane.
- content_type
- str
Typ zawartości parametru treści. Znane wartości to: "application/json". Wartość domyślna to Brak.
- cls
- callable
Niestandardowy typ lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
- continuation_token
- str
Token kontynuacji umożliwiający ponowne uruchomienie narzędzia poller z zapisanego stanu.
- polling
- bool lub PollingMethod
Domyślnie metoda sondowania będzie mieć wartość ARMPolling. Przekaż wartość False dla tej operacji, aby nie sondować lub przekazać własny zainicjowany obiekt sondowania dla osobistej strategii sondowania.
- polling_interval
- int
Domyślny czas oczekiwania między dwoma sondami dla operacji LRO, jeśli nie ma Retry-After nagłówka.
Zwraca
Wystąpienie LROPoller zwracające element ResourceGroupExportResult lub wynik cls(response)
Typ zwracany
Wyjątki
check_existence
Sprawdza, czy grupa zasobów istnieje.
check_existence(resource_group_name: str, **kwargs: Any) -> bool
Parametry
- resource_group_name
- str
Nazwa grupy zasobów do sprawdzenia. W nazwie jest uwzględniana wielkość liter. Wymagane.
- cls
- callable
Niestandardowy typ lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
Zwraca
bool lub wynik cls(response)
Typ zwracany
Wyjątki
create_or_update
Tworzy lub aktualizuje grupę zasobów.
create_or_update(resource_group_name: str, parameters: _models.ResourceGroup, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroup
Parametry
- resource_group_name
- str
Nazwa grupy zasobów do utworzenia lub zaktualizowania. Może zawierać znaki alfanumeryczne, podkreślenie, nawiasy, łącznik, kropkę (z wyjątkiem końca) i znaki Unicode zgodne z dozwolonymi znakami. Wymagane.
- parameters
- ResourceGroup lub IO
Parametry dostarczone do tworzenia lub aktualizowania grupy zasobów. Jest typem ResourceGroup lub typem we/wy. Wymagane.
- content_type
- str
Typ zawartości parametru treści. Znane wartości to: "application/json". Wartość domyślna to Brak.
- cls
- callable
Niestandardowy typ lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
Zwraca
ResourceGroup lub wynik cls(response)
Typ zwracany
Wyjątki
get
Pobiera grupę zasobów.
get(resource_group_name: str, **kwargs: Any) -> ResourceGroup
Parametry
- resource_group_name
- str
Nazwa grupy zasobów do pobrania. W nazwie jest uwzględniana wielkość liter. Wymagane.
- cls
- callable
Niestandardowy typ lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
Zwraca
ResourceGroup lub wynik cls(response)
Typ zwracany
Wyjątki
list
Pobiera wszystkie grupy zasobów dla subskrypcji.
list(filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[ResourceGroup]
Parametry
- filter
- str
Filtr do zastosowania w operacji.:code:
:code:>><<<br>
Można filtrować według nazw tagów i wartości. Aby na przykład filtrować nazwę i wartość tagu, użyj polecenia $filter=tagName eq "tag1" i tagValue eq "Value1". Wartość domyślna to Brak.
- top
- int
Liczba wyników do zwrócenia. Jeśli wartość null jest przekazywana, zwraca wszystkie grupy zasobów. Wartość domyślna to Brak.
- cls
- callable
Niestandardowy typ lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
Zwraca
Iterator, taki jak wystąpienie grupy zasobów lub wynik cls(response)
Typ zwracany
Wyjątki
update
Aktualizacje grupę zasobów.
Grupy zasobów można zaktualizować za pomocą prostej operacji PATCH na adres grupy. Format żądania jest taki sam jak w przypadku tworzenia grupy zasobów. Jeśli pole jest nieokreślone, bieżąca wartość zostanie zachowana.
update(resource_group_name: str, parameters: _models.ResourceGroupPatchable, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroup
Parametry
- resource_group_name
- str
Nazwa grupy zasobów do zaktualizowania. W nazwie jest uwzględniana wielkość liter. Wymagane.
- parameters
- ResourceGroupPatchable lub IO
Parametry dostarczone w celu zaktualizowania grupy zasobów. Jest typem ResourceGroupPatchable lub typem we/wy. Wymagane.
- content_type
- str
Typ zawartości parametru treści. Znane wartości to: "application/json". Wartość domyślna to Brak.
- cls
- callable
Niestandardowy typ lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
Zwraca
ResourceGroup lub wynik cls(response)
Typ zwracany
Wyjątki
Atrybuty
models
models = <module 'azure.mgmt.resource.resources.v2021_01_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2021_01_01\\models\\__init__.py'>
Azure SDK for Python