ResourcesOperations Třída
Upozornění
NEVYTVOŘETE instanci této třídy přímo.
Místo toho byste měli přistupovat k následujícím operacím prostřednictvím
<xref:resources> Atribut.
- Dědičnost
-
builtins.objectResourcesOperations
Konstruktor
ResourcesOperations(*args, **kwargs)
Metody
begin_create_or_update |
Vytvoří prostředek. |
begin_create_or_update_by_id |
Vytvořte prostředek podle ID. |
begin_delete |
Odstraní prostředek. |
begin_delete_by_id |
Odstraní prostředek podle ID. |
begin_move_resources |
Přesune prostředky z jedné skupiny prostředků do jiné. Prostředky, které se mají přesunout, musí být ve stejné zdrojové skupině prostředků v použitém zdrojovém předplatném. Cílová skupina prostředků může být v jiném předplatném. Při přesouvání prostředků se po dobu trvání operace uzamkne zdrojová i cílová skupina. Operace zápisu a odstranění se u skupin blokují, dokud se přesun neskonří. |
begin_update |
Aktualizace prostředku. |
begin_update_by_id |
Aktualizace prostředek podle ID. |
begin_validate_move_resources |
Ověří, jestli je možné prostředky přesunout z jedné skupiny prostředků do jiné. Tato operace zkontroluje, jestli je možné přesunout zadané prostředky do cíle. Prostředky, které se mají přesunout, musí být ve stejné zdrojové skupině prostředků v použitém zdrojovém předplatném. Cílová skupina prostředků může být v jiném předplatném. Pokud ověření proběhne úspěšně, vrátí kód odpovědi HTTP 204 (bez obsahu). Pokud ověření selže, vrátí kód odpovědi HTTP 409 (Konflikt) s chybovou zprávou. Načtením adresy URL v hodnotě hlavičky Umístění zkontrolujte výsledek dlouhotrvající operace. |
check_existence |
Zkontroluje, jestli prostředek existuje. |
check_existence_by_id |
Zkontroluje podle ID, jestli prostředek existuje. Toto rozhraní API v současné době funguje jenom pro omezenou sadu poskytovatelů prostředků. V případě, že poskytovatel prostředků toto rozhraní API neimplementuje, arm odpoví 405. Alternativou pak je použití rozhraní GET API ke kontrole existence prostředku. |
get |
Získá prostředek. |
get_by_id |
Získá prostředek podle ID. |
list |
Získejte všechny prostředky v předplatném. |
list_by_resource_group |
Získejte všechny prostředky pro skupinu prostředků. |
begin_create_or_update
Vytvoří prostředek.
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
Název skupiny prostředků pro prostředek. V názvu se rozlišují malá a velká písmena. Povinná hodnota.
- parameters
- GenericResource nebo IO
Parametry pro vytvoření nebo aktualizaci prostředku Je buď typ GenericResource, nebo vstupně-výstupní typ. Povinná hodnota.
- content_type
- str
Content-type parametru textu. Známé hodnoty jsou: application/json. Výchozí hodnota je Žádná.
- cls
- callable
Vlastní typ nebo funkce, které budou předány přímé odpovědi
- continuation_token
- str
Pokračovací token pro restartování poller z uloženého stavu.
- polling
- bool nebo PollingMethod
Ve výchozím nastavení bude metodou dotazování ARMPolling. Předejte hodnotu False pro tuto operaci, pokud se nechcete dotazovat, nebo předejte vlastní inicializovaný objekt dotazování pro osobní strategii dotazování.
- polling_interval
- int
Výchozí čekací doba mezi dvěma dotazy na operace LRO, pokud není k dispozici žádná hlavička Retry-After.
Návraty
Instance LROPoller, která vrací GenericResource nebo výsledek cls(response)
Návratový typ
Výjimky
begin_create_or_update_by_id
Vytvořte prostředek podle ID.
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
Plně kvalifikované ID prostředku, včetně názvu a typu prostředku. Použijte formát /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{typ_prostředku}/{název_prostředku}. Povinná hodnota.
- parameters
- GenericResource nebo IO
Vytvořte nebo aktualizujte parametry prostředků. Je buď typ GenericResource, nebo vstupně-výstupní typ. Povinná hodnota.
- content_type
- str
Content-type parametru textu. Známé hodnoty jsou: application/json. Výchozí hodnota je Žádná.
- cls
- callable
Vlastní typ nebo funkce, které budou předány přímé odpovědi
- continuation_token
- str
Pokračovací token pro restartování poller z uloženého stavu.
- polling
- bool nebo PollingMethod
Ve výchozím nastavení bude metodou dotazování ARMPolling. Předejte hodnotu False pro tuto operaci, pokud se nechcete dotazovat, nebo předejte vlastní inicializovaný objekt dotazování pro osobní strategii dotazování.
- polling_interval
- int
Výchozí čekací doba mezi dvěma dotazy na operace LRO, pokud není k dispozici žádná hlavička Retry-After.
Návraty
Instance LROPoller, která vrací GenericResource nebo výsledek cls(response)
Návratový typ
Výjimky
begin_delete
Odstraní prostředek.
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
Název skupiny prostředků, která obsahuje prostředek, který se má odstranit. V názvu se rozlišují malá a velká písmena. Povinná hodnota.
- cls
- callable
Vlastní typ nebo funkce, které budou předány přímé odpovědi
- continuation_token
- str
Pokračovací token pro restartování poller z uloženého stavu.
- polling
- bool nebo PollingMethod
Ve výchozím nastavení bude metodou dotazování ARMPolling. Předejte hodnotu False pro tuto operaci, pokud se nechcete dotazovat, nebo předejte vlastní inicializovaný objekt dotazování pro osobní strategii dotazování.
- polling_interval
- int
Výchozí čekací doba mezi dvěma dotazy na operace LRO, pokud není k dispozici žádná hlavička Retry-After.
Návraty
Instance LROPoller, která vrátí buď None, nebo výsledek cls(response)
Návratový typ
Výjimky
begin_delete_by_id
Odstraní prostředek podle ID.
begin_delete_by_id(resource_id: str, api_version: str, **kwargs: Any) -> LROPoller[None]
Parametry
- resource_id
- str
Plně kvalifikované ID prostředku, včetně názvu a typu prostředku. Použijte formát /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{typ_prostředku}/{název_prostředku}. Povinná hodnota.
- cls
- callable
Vlastní typ nebo funkce, které budou předány přímé odpovědi
- continuation_token
- str
Pokračovací token pro restartování poller z uloženého stavu.
- polling
- bool nebo PollingMethod
Ve výchozím nastavení bude metodou dotazování ARMPolling. Předejte hodnotu False pro tuto operaci, pokud se nechcete dotazovat, nebo předejte vlastní inicializovaný objekt dotazování pro osobní strategii dotazování.
- polling_interval
- int
Výchozí čekací doba mezi dvěma dotazy na operace LRO, pokud není k dispozici žádná hlavička Retry-After.
Návraty
Instance LROPoller, která vrátí buď None, nebo výsledek cls(response)
Návratový typ
Výjimky
begin_move_resources
Přesune prostředky z jedné skupiny prostředků do jiné.
Prostředky, které se mají přesunout, musí být ve stejné zdrojové skupině prostředků v použitém zdrojovém předplatném. Cílová skupina prostředků může být v jiném předplatném. Při přesouvání prostředků se po dobu trvání operace uzamkne zdrojová i cílová skupina. Operace zápisu a odstranění se u skupin blokují, dokud se přesun neskonří.
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
Název skupiny prostředků ze zdrojového předplatného obsahující prostředky, které se mají přesunout. Povinná hodnota.
- parameters
- ResourcesMoveInfo nebo IO
Parametry pro přesun prostředků Je buď typ ResourcesMoveInfo, nebo vstupně-výstupní typ. Povinná hodnota.
- content_type
- str
Content-type parametru textu. Známé hodnoty jsou: application/json. Výchozí hodnota je Žádná.
- cls
- callable
Vlastní typ nebo funkce, které budou předány přímé odpovědi
- continuation_token
- str
Pokračovací token pro restartování poller z uloženého stavu.
- polling
- bool nebo PollingMethod
Ve výchozím nastavení bude metodou dotazování ARMPolling. Předejte hodnotu False pro tuto operaci, pokud se nechcete dotazovat, nebo předejte vlastní inicializovaný objekt dotazování pro osobní strategii dotazování.
- polling_interval
- int
Výchozí čekací doba mezi dvěma dotazy na operace LRO, pokud není k dispozici žádná hlavička Retry-After.
Návraty
Instance LROPoller, která vrací buď None, nebo výsledek cls(response)
Návratový typ
Výjimky
begin_update
Aktualizace prostředku.
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
Název skupiny prostředků pro prostředek. V názvu se rozlišují malá a velká písmena. Povinná hodnota.
- parameters
- GenericResource nebo IO
Parametry pro aktualizaci prostředku Je buď typ GenericResource, nebo vstupně-výstupní typ. Povinná hodnota.
- content_type
- str
Typ obsahu parametru body. Známé hodnoty jsou: application/json. Výchozí hodnota je Žádná.
- cls
- callable
Vlastní typ nebo funkce, které budou předány přímé odpovědi
- continuation_token
- str
Pokračovací token pro restartování polleru z uloženého stavu.
- polling
- bool nebo PollingMethod
Ve výchozím nastavení bude metoda dotazování ARMPolling. Předejte nepravdě pro tuto operaci, aby se nezotkejte, nebo předejte vlastní inicializovaný objekt dotazování pro osobní strategii dotazování.
- polling_interval
- int
Výchozí doba čekání mezi dvěma dotazy na operace LRO, pokud není k dispozici žádná hlavička Retry-After.
Návraty
Instance LROPoller, která vrací buď GenericResource, nebo výsledek cls(response)
Návratový typ
Výjimky
begin_update_by_id
Aktualizace prostředek podle ID.
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
Plně kvalifikované ID prostředku, včetně názvu a typu prostředku. Použijte formát /subscriptions/{guid}/resourceGroups/{název_skupiny_prostředků}/{resource-provider-namespace}/{resource-type}/{název_prostředku}. Povinná hodnota.
- parameters
- GenericResource nebo IO
Aktualizujte parametry prostředku. Je buď typ GenericResource, nebo vstupně-výstupní typ. Povinná hodnota.
- content_type
- str
Typ obsahu parametru body. Známé hodnoty jsou: application/json. Výchozí hodnota je Žádná.
- cls
- callable
Vlastní typ nebo funkce, které budou předány přímé odpovědi
- continuation_token
- str
Pokračovací token pro restartování polleru z uloženého stavu.
- polling
- bool nebo PollingMethod
Ve výchozím nastavení bude metoda dotazování ARMPolling. Předejte nepravdě pro tuto operaci, aby se nezotkejte, nebo předejte vlastní inicializovaný objekt dotazování pro osobní strategii dotazování.
- polling_interval
- int
Výchozí doba čekání mezi dvěma dotazy na operace LRO, pokud není k dispozici žádná hlavička Retry-After.
Návraty
Instance LROPoller, která vrací buď GenericResource, nebo výsledek cls(response)
Návratový typ
Výjimky
begin_validate_move_resources
Ověří, jestli je možné prostředky přesunout z jedné skupiny prostředků do jiné.
Tato operace zkontroluje, jestli je možné přesunout zadané prostředky do cíle. Prostředky, které se mají přesunout, musí být ve stejné zdrojové skupině prostředků v použitém zdrojovém předplatném. Cílová skupina prostředků může být v jiném předplatném. Pokud ověření proběhne úspěšně, vrátí kód odpovědi HTTP 204 (bez obsahu). Pokud ověření selže, vrátí kód odpovědi HTTP 409 (Konflikt) s chybovou zprávou. Načtením adresy URL v hodnotě hlavičky Umístění zkontrolujte výsledek dlouhotrvající operace.
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
Název skupiny prostředků ze zdrojového předplatného obsahující prostředky, které se mají ověřit pro přesun. Povinná hodnota.
- parameters
- ResourcesMoveInfo nebo IO
Parametry pro přesun prostředků Je typ ResourcesMoveInfo nebo vstupně-výstupní operace. Povinná hodnota.
- content_type
- str
Typ obsahu parametru body. Známé hodnoty jsou: application/json. Výchozí hodnota je Žádná.
- cls
- callable
Vlastní typ nebo funkce, které budou předány přímé odpovědi
- continuation_token
- str
Pokračovací token pro restartování polleru z uloženého stavu.
- polling
- bool nebo PollingMethod
Ve výchozím nastavení bude metoda dotazování ARMPolling. Předejte nepravdě pro tuto operaci, aby se nezotkejte, nebo předejte vlastní inicializovaný objekt dotazování pro osobní strategii dotazování.
- polling_interval
- int
Výchozí doba čekání mezi dvěma dotazy na operace LRO, pokud není k dispozici žádná hlavička Retry-After.
Návraty
Instance LROPoller, která vrací buď None, nebo výsledek cls(response)
Návratový typ
Výjimky
check_existence
Zkontroluje, jestli prostředek existuje.
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
Název skupiny prostředků obsahující prostředek, který chcete zkontrolovat. V názvu se rozlišují malá a velká písmena. Povinná hodnota.
- resource_provider_namespace
- str
Poskytovatel prostředků prostředku, který chcete zkontrolovat. Povinná hodnota.
- resource_name
- str
Název prostředku, který má zkontrolovat, jestli existuje. Povinná hodnota.
- cls
- callable
Vlastní typ nebo funkce, které budou předány přímé odpovědi
Návraty
bool nebo výsledek cls(response)
Návratový typ
Výjimky
check_existence_by_id
Zkontroluje podle ID, jestli prostředek existuje. Toto rozhraní API v současné době funguje jenom pro omezenou sadu poskytovatelů prostředků. V případě, že poskytovatel prostředků toto rozhraní API neimplementuje, arm odpoví 405. Alternativou pak je použití rozhraní GET API ke kontrole existence prostředku.
check_existence_by_id(resource_id: str, api_version: str, **kwargs: Any) -> bool
Parametry
- resource_id
- str
Plně kvalifikované ID prostředku, včetně názvu a typu prostředku. Použijte formát /subscriptions/{guid}/resourceGroups/{název_skupiny_prostředků}/{resource-provider-namespace}/{resource-type}/{název_prostředku}. Povinná hodnota.
- cls
- callable
Vlastní typ nebo funkce, které budou předány přímé odpovědi
Návraty
bool nebo výsledek cls(response)
Návratový typ
Výjimky
get
Získá prostředek.
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
Název skupiny prostředků obsahující prostředek, který chcete získat. V názvu se rozlišují malá a velká písmena. Povinná hodnota.
- cls
- callable
Vlastní typ nebo funkce, které budou předány přímé odpovědi
Návraty
GenericResource nebo výsledek cls(response)
Návratový typ
Výjimky
get_by_id
Získá prostředek podle ID.
get_by_id(resource_id: str, api_version: str, **kwargs: Any) -> GenericResource
Parametry
- resource_id
- str
Plně kvalifikované ID prostředku, včetně názvu a typu prostředku. Použijte formát /subscriptions/{guid}/resourceGroups/{název_skupiny_prostředků}/{resource-provider-namespace}/{resource-type}/{název_prostředku}. Povinná hodnota.
- cls
- callable
Vlastní typ nebo funkce, které budou předány přímé odpovědi
Návraty
GenericResource nebo výsledek cls(response)
Návratový typ
Výjimky
list
Získejte všechny prostředky v předplatném.
list(filter: str | None = None, expand: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[GenericResourceExpanded]
Parametry
- filter
- str
Filtr, který se má použít na operaci.:code:<br>
Operátory porovnání filtrů zahrnují eq
(rovná se) a ne
(ne rovno) a lze je použít s následujícími vlastnostmi: location
, resourceType
, name
, identity
plan
resourceGroup
identity/principalId
plan/publisher
, plan/product
, , plan/name
, , plan/version
a plan/promotionCode
.:code:<br>
Pokud chcete například filtrovat podle typu prostředku, použijte $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
a/`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,
původní značky pro každý prostředek se ve výsledcích nevrátí.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 and plan/publisher and plan/name, and
identity and identity/principalId'. Výchozí hodnota je Žádná.
- expand
- str
Seznam dalších vlastností oddělených čárkami, které se mají zahrnout do odpovědi.
Platné hodnoty zahrnují createdTime
, changedTime
a provisioningState
. Například, $expand=createdTime,changedTime
. Výchozí hodnota je Žádná.
- top
- int
Počet doporučení na stránku, pokud se používá stránkovaná verze tohoto rozhraní API. Výchozí hodnota je Žádná.
- cls
- callable
Vlastní typ nebo funkce, které budou předány přímé odpovědi
Návraty
Iterátor, jako je instance GenericResourceExpanded nebo výsledek cls(response)
Návratový typ
Výjimky
list_by_resource_group
Získejte všechny prostředky pro skupinu prostředků.
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
- resource_group_name
- str
Skupina prostředků s prostředky, které chcete získat. Povinná hodnota.
- filter
- str
Filtr, který se má použít na operaci.:code:<br>
Vlastnosti, které můžete použít pro eq (rovná se) nebo ne (ne rovno), jsou: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.:code:<br>``<br>
Například k filtrování podle typu prostředku použijte: $filter=resourceType eq 'Microsoft.Network/virtualNetworks':code:<br>``<br>
Ve filtru můžete použít substringof(hodnota, vlastnost). Vlastnosti, které můžete použít pro podřetězce, jsou: name a resourceGroup.:code:<br>``<br>
Pokud například chcete získat všechny prostředky s ukázkou kdekoli v názvu, použijte: $filter=substringof('demo', name):code:<br>``<br>
Přidáním operátorů a/nebo můžete propojit více podřetězce.:code:<br>``<br>
Můžete filtrovat podle názvů značek a hodnot. Pokud chcete například filtrovat název a hodnotu značky, použijte $filter=tagName eq 'tag1' a tagValue eq 'Hodnota1'. Při filtrování podle názvu a hodnoty značky se značky pro každý prostředek nevrátí ve výsledcích.:code:<br>
:code::>><<<br>
Při filtrování můžete některé vlastnosti použít společně. Můžete použít tyto kombinace: podřetězce a/nebo resourceType, plán a plán/vydavatel a plan/name, identity a identity/principalId. Výchozí hodnota je Žádná.
- expand
- str
Seznam dalších vlastností oddělených čárkami, které se mají zahrnout do odpovědi.
Platné hodnoty zahrnují createdTime
, changedTime
a provisioningState
. Například, $expand=createdTime,changedTime
. Výchozí hodnota je Žádná.
- top
- int
Počet výsledků, které se mají vrátit. Pokud se předá hodnota null, vrátí všechny prostředky. Výchozí hodnota je Žádná.
- cls
- callable
Vlastní typ nebo funkce, které budou předány přímé odpovědi
Návraty
Iterátor, jako je instance GenericResourceExpanded nebo výsledek cls(response)
Návratový typ
Výjimky
Atributy
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
Váš názor
https://aka.ms/ContentUserFeedback.
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu:Odeslat a zobrazit názory pro