ResourcesOperations 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:resources> Atrybut.
- Dziedziczenie
-
builtins.objectResourcesOperations
Konstruktor
ResourcesOperations(*args, **kwargs)
Metody
begin_create_or_update |
Tworzy zasób. |
begin_create_or_update_by_id |
Utwórz zasób według identyfikatora. |
begin_delete |
Usuwa zasób. |
begin_delete_by_id |
Usuwa zasób według identyfikatora. |
begin_move_resources |
Przenosi zasoby z jednej grupy zasobów do innej grupy zasobów. Zasoby do przeniesienia muszą znajdować się w tej samej źródłowej grupie zasobów w używanej subskrypcji źródłowej. Docelowa grupa zasobów może znajdować się w innej subskrypcji. Podczas przenoszenia zasobów zarówno grupa źródłowa, jak i grupa docelowa są blokowane na czas trwania operacji. Operacje zapisu i usuwania są blokowane w grupach do czasu zakończenia przenoszenia. |
begin_update |
Aktualizacje zasób. |
begin_update_by_id |
Aktualizacje zasób według identyfikatora. |
begin_validate_move_resources |
Sprawdza, czy zasoby można przenieść z jednej grupy zasobów do innej grupy zasobów. Ta operacja sprawdza, czy określone zasoby można przenieść do obiektu docelowego. Zasoby do przeniesienia muszą znajdować się w tej samej źródłowej grupie zasobów w używanej subskrypcji źródłowej. Docelowa grupa zasobów może znajdować się w innej subskrypcji. Jeśli walidacja zakończy się pomyślnie, zwraca kod odpowiedzi HTTP 204 (brak zawartości). Jeśli walidacja nie powiedzie się, zwraca kod odpowiedzi HTTP 409 (konflikt) z komunikatem o błędzie. Pobierz adres URL w wartości nagłówka Location, aby sprawdzić wynik długotrwałej operacji. |
check_existence |
Sprawdza, czy zasób istnieje. |
check_existence_by_id |
Sprawdza według identyfikatora, czy zasób istnieje. Ten interfejs API obecnie działa tylko dla ograniczonego zestawu dostawców zasobów. W przypadku, gdy dostawca zasobów nie implementuje tego interfejsu API, usługa ARM odpowie przy użyciu wartości 405. Alternatywą jest użycie interfejsu API GET w celu sprawdzenia istnienia zasobu. |
get |
Pobiera zasób. |
get_by_id |
Pobiera zasób według identyfikatora. |
list |
Pobierz wszystkie zasoby w subskrypcji. |
list_by_resource_group |
Pobierz wszystkie zasoby dla grupy zasobów. |
begin_create_or_update
Tworzy zasób.
begin_create_or_update(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]
Parametry
- resource_group_name
- str
Nazwa grupy zasobów dla zasobu. W nazwie jest uwzględniana wielkość liter. Wymagane.
- parameters
- GenericResource lub IO
Parametry służące do tworzenia lub aktualizowania zasobu. Jest typem GenericResource 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
Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
- continuation_token
- str
Token kontynuacji w celu ponownego uruchomienia bazy danych poller ze stanu zapisanego.
- polling
- bool lub PollingMethod
Domyślnie metoda sondowania będzie 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ść GenericResource lub wynik cls(response)
Typ zwracany
Wyjątki
begin_create_or_update_by_id
Utwórz zasób według identyfikatora.
begin_create_or_update_by_id(resource_id: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]
Parametry
- resource_id
- str
W pełni kwalifikowany identyfikator zasobu, w tym nazwa zasobu i typ zasobu. Użyj formatu /subscriptions/{guid}/resourceGroups/{nazwa-grupy_zasobów}/{resource-provider-namespace}/{resource-type}/{nazwa-zasobu}. Wymagane.
- parameters
- GenericResource lub IO
Tworzenie lub aktualizowanie parametrów zasobów. Jest typem GenericResource 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
Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
- continuation_token
- str
Token kontynuacji w celu ponownego uruchomienia bazy danych poller ze stanu zapisanego.
- polling
- bool lub PollingMethod
Domyślnie metoda sondowania będzie 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ść GenericResource lub wynik cls(response)
Typ zwracany
Wyjątki
begin_delete
Usuwa zasób.
begin_delete(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) -> LROPoller[None]
Parametry
- resource_group_name
- str
Nazwa grupy zasobów zawierającej zasób do usunięcia. W nazwie jest uwzględniana wielkość liter. Wymagane.
- cls
- callable
Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
- continuation_token
- str
Token kontynuacji w celu ponownego uruchomienia bazy danych poller ze stanu zapisanego.
- polling
- bool lub PollingMethod
Domyślnie metoda sondowania będzie 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_delete_by_id
Usuwa zasób według identyfikatora.
begin_delete_by_id(resource_id: str, api_version: str, **kwargs: Any) -> LROPoller[None]
Parametry
- resource_id
- str
W pełni kwalifikowany identyfikator zasobu, w tym nazwa zasobu i typ zasobu. Użyj formatu /subscriptions/{guid}/resourceGroups/{nazwa-grupy_zasobów}/{resource-provider-namespace}/{resource-type}/{nazwa-zasobu}. Wymagane.
- cls
- callable
Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
- continuation_token
- str
Token kontynuacji w celu ponownego uruchomienia bazy danych poller ze stanu zapisanego.
- polling
- bool lub PollingMethod
Domyślnie metoda sondowania będzie 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_move_resources
Przenosi zasoby z jednej grupy zasobów do innej grupy zasobów.
Zasoby do przeniesienia muszą znajdować się w tej samej źródłowej grupie zasobów w używanej subskrypcji źródłowej. Docelowa grupa zasobów może znajdować się w innej subskrypcji. Podczas przenoszenia zasobów zarówno grupa źródłowa, jak i grupa docelowa są blokowane na czas trwania operacji. Operacje zapisu i usuwania są blokowane w grupach do czasu zakończenia przenoszenia.
begin_move_resources(source_resource_group_name: str, parameters: _models.ResourcesMoveInfo, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
Parametry
- source_resource_group_name
- str
Nazwa grupy zasobów z subskrypcji źródłowej zawierającej zasoby do przeniesienia. Wymagane.
- parameters
- ResourcesMoveInfo lub IO
Parametry przenoszenia zasobów. Jest typem ResourcesMoveInfo 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
Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
- continuation_token
- str
Token kontynuacji w celu ponownego uruchomienia bazy danych poller ze stanu zapisanego.
- polling
- bool lub PollingMethod
Domyślnie metoda sondowania będzie 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_update
Aktualizacje zasób.
begin_update(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]
Parametry
- resource_group_name
- str
Nazwa grupy zasobów dla zasobu. W nazwie jest uwzględniana wielkość liter. Wymagane.
- parameters
- GenericResource lub IO
Parametry służące do aktualizowania zasobu. Jest typem GenericResource 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
Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
- continuation_token
- str
Token kontynuacji w celu ponownego uruchomienia bazy danych poller ze stanu zapisanego.
- polling
- bool lub PollingMethod
Domyślnie metoda sondowania będzie 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ść GenericResource lub wynik cls(response)
Typ zwracany
Wyjątki
begin_update_by_id
Aktualizacje zasób według identyfikatora.
begin_update_by_id(resource_id: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]
Parametry
- resource_id
- str
W pełni kwalifikowany identyfikator zasobu, w tym nazwa zasobu i typ zasobu. Użyj formatu /subscriptions/{guid}/resourceGroups/{nazwa-grupy_zasobów}/{resource-provider-namespace}/{resource-type}/{nazwa-zasobu}. Wymagane.
- parameters
- GenericResource lub IO
Aktualizowanie parametrów zasobu. Jest typem GenericResource 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
Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
- continuation_token
- str
Token kontynuacji w celu ponownego uruchomienia bazy danych poller ze stanu zapisanego.
- polling
- bool lub PollingMethod
Domyślnie metoda sondowania będzie 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ść GenericResource lub wynik cls(response)
Typ zwracany
Wyjątki
begin_validate_move_resources
Sprawdza, czy zasoby można przenieść z jednej grupy zasobów do innej grupy zasobów.
Ta operacja sprawdza, czy określone zasoby można przenieść do obiektu docelowego. Zasoby do przeniesienia muszą znajdować się w tej samej źródłowej grupie zasobów w używanej subskrypcji źródłowej. Docelowa grupa zasobów może znajdować się w innej subskrypcji. Jeśli walidacja zakończy się pomyślnie, zwraca kod odpowiedzi HTTP 204 (brak zawartości). Jeśli walidacja nie powiedzie się, zwraca kod odpowiedzi HTTP 409 (konflikt) z komunikatem o błędzie. Pobierz adres URL w wartości nagłówka Location, aby sprawdzić wynik długotrwałej operacji.
begin_validate_move_resources(source_resource_group_name: str, parameters: _models.ResourcesMoveInfo, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]
Parametry
- source_resource_group_name
- str
Nazwa grupy zasobów z subskrypcji źródłowej zawierającej zasoby do zweryfikowania pod kątem przenoszenia. Wymagane.
- parameters
- ResourcesMoveInfo lub IO
Parametry przenoszenia zasobów. Jest typem ResourcesMoveInfo 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
Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
- continuation_token
- str
Token kontynuacji w celu ponownego uruchomienia bazy danych poller ze stanu zapisanego.
- polling
- bool lub PollingMethod
Domyślnie metoda sondowania będzie 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
check_existence
Sprawdza, czy zasób istnieje.
check_existence(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) -> bool
Parametry
- resource_group_name
- str
Nazwa grupy zasobów zawierającej zasób do sprawdzenia. W nazwie jest uwzględniana wielkość liter. Wymagane.
- cls
- callable
Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
Zwraca
bool lub wynik cls(response)
Typ zwracany
Wyjątki
check_existence_by_id
Sprawdza według identyfikatora, czy zasób istnieje. Ten interfejs API obecnie działa tylko dla ograniczonego zestawu dostawców zasobów. W przypadku, gdy dostawca zasobów nie implementuje tego interfejsu API, usługa ARM odpowie przy użyciu wartości 405. Alternatywą jest użycie interfejsu API GET w celu sprawdzenia istnienia zasobu.
check_existence_by_id(resource_id: str, api_version: str, **kwargs: Any) -> bool
Parametry
- resource_id
- str
W pełni kwalifikowany identyfikator zasobu, w tym nazwa zasobu i typ zasobu. Użyj formatu /subscriptions/{guid}/resourceGroups/{nazwa-grupy_zasobów}/{resource-provider-namespace}/{resource-type}/{nazwa-zasobu}. Wymagane.
- cls
- callable
Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
Zwraca
bool lub wynik cls(response)
Typ zwracany
Wyjątki
get
Pobiera zasób.
get(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) -> GenericResource
Parametry
- resource_group_name
- str
Nazwa grupy zasobów zawierającej zasób do pobrania. W nazwie jest uwzględniana wielkość liter. Wymagane.
- cls
- callable
Niestandardowy typ lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
Zwraca
GenericResource lub wynik cls(response)
Typ zwracany
Wyjątki
get_by_id
Pobiera zasób według identyfikatora.
get_by_id(resource_id: str, api_version: str, **kwargs: Any) -> GenericResource
Parametry
- resource_id
- str
W pełni kwalifikowany identyfikator zasobu, w tym nazwa zasobu i typ zasobu. Użyj formatu /subscriptions/{guid}/resourceGroups/{nazwa-grupy zasobów}/{resource-provider-namespace}/{resource-type}/{nazwa-zasobu}. Wymagane.
- cls
- callable
Niestandardowy typ lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
Zwraca
GenericResource lub wynik cls(response)
Typ zwracany
Wyjątki
list
Pobierz wszystkie zasoby w subskrypcji.
list(filter: str | None = None, expand: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[GenericResourceExpanded]
Parametry
- filter
- str
Filtr do zastosowania w operacji.:code:<br>
Operatory porównania filtrów obejmują eq
(równe) i (nie równe) i ne
mogą być używane z następującymi właściwościami: location
, name
identity
identity/principalId
plan
resourceGroup
resourceType
plan/product
plan/name
plan/publisher
plan/version
i plan/promotionCode
.:code:<br>
Aby na przykład filtrować według typu zasobu, użyj polecenia $filter=resourceType eq 'Microsoft.Network/virtualNetworks'```<br>
<br>` `substringof(value, property)` can be used to filter for substrings of the following currently-supported properties: `name` and `resourceGroup
<br>`For example, to get all resources with 'demo' anywhere in the resource name, use
$filter=substringof('demo', name)''<br>`Multiple substring operations can also be combined using
i/`or` operators.:code:*<br>*`<br>`Note that any truncated number of results queried via
$top may also not be compatible when using a filter.:code:*<br>*`<br>
Resources can be filtered by tag names and values. For example, to filter for a tag name and value, use ``$filter=tagName eq 'tag1' and tagValue eq 'Value1'``. Note that when resources are filtered by tag name and value,
oryginalne tagi dla każdego zasobu nie zostaną zwrócone w wynikach.Any list of additional properties queried via
$expandmay also not be compatible when filtering by tag names/values.
<br>`For tag names only, resources can be filtered by prefix using the following syntax:
$filter=startswith(tagName, 'depart'). This query will return all resources with a tag name prefixed by the phrase `depart` (i.e.`department`, `departureDate`, `departureTime`, etc.):code:*<br>*`<br>
Note that some properties can be combined when filtering resources, which include the following: ``substringof() and/or resourceType``,
plan i plan/wydawca i plan/tożsamość, and
i tożsamość/tożsamość/principalId". Wartość domyślna to Brak.
- expand
- str
Rozdzielona przecinkami lista dodatkowych właściwości, które mają zostać uwzględnione w odpowiedzi.
Prawidłowe wartości to createdTime
, changedTime
i provisioningState
. Na przykład $expand=createdTime,changedTime
. Wartość domyślna to Brak.
- top
- int
Liczba zaleceń na stronę, jeśli jest używana stronicowana wersja tego interfejsu API. Wartość domyślna to Brak.
- cls
- callable
Niestandardowy typ lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
Zwraca
Iterator podobny do wystąpienia genericResourceExpanded lub wyniku cls(response)
Typ zwracany
Wyjątki
list_by_resource_group
Pobierz wszystkie zasoby dla grupy zasobów.
list_by_resource_group(resource_group_name: str, filter: str | None = None, expand: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[GenericResourceExpanded]
Parametry
- filter
- str
Filtr do zastosowania w operacji.:code:<br>
Właściwości, których można użyć dla eq (równa się) lub ne (nie równa się) to: lokalizacja, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version i plan/promotionCode.:code:code:<br>``<br>
na przykład do filtrowania według typu zasobu, użyj: $filter=resourceType eq 'Microsoft.Network/virtualNetworks':code:<br>``<br>
Można użyć podciągu(wartość, właściwość) w filtrze. Właściwości, których można użyć do podciągów, to: name i resourceGroup.:code::Code:<br>``<br>
Na przykład, aby pobrać wszystkie zasoby z "demo" w dowolnym miejscu w nazwie, użyj polecenia: $filter=substringof('demo', name):code:Code:<br>``<br>
Można połączyć więcej niż jeden podciąg, dodając operatory i/lub operatory.:code:Kod:<br>``<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". Podczas filtrowania według nazwy i wartości tagów tagi dla każdego zasobu nie są zwracane w wynikach.:code::code:<br>
code:>><<<br>
Można użyć niektórych właściwości razem podczas filtrowania. Kombinacje, których można użyć, to: podciąg i/lub typ zasobu, plan i plan/wydawca oraz plan/nazwa, tożsamość i tożsamość/principalId. Wartość domyślna to Brak.
- expand
- str
Rozdzielona przecinkami lista dodatkowych właściwości, które mają zostać uwzględnione w odpowiedzi.
Prawidłowe wartości to createdTime
, changedTime
i provisioningState
. Na przykład $expand=createdTime,changedTime
. Wartość domyślna to Brak.
- top
- int
Liczba wyników do zwrócenia. Jeśli wartość null jest przekazywana, zwraca wszystkie zasoby. Wartość domyślna to Brak.
- cls
- callable
Niestandardowy typ lub funkcja, która zostanie przekazana bezpośrednia odpowiedź
Zwraca
Iterator podobny do wystąpienia genericResourceExpanded lub wyniku cls(response)
Typ zwracany
Wyjątki
Atrybuty
models
models = <module 'azure.mgmt.resource.resources.v2022_09_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2022_09_01\\models\\__init__.py'>
Azure SDK for Python