ResourceGroupsOperations Klass

  • Referens

Varning

Instansiera INTE den här klassen direkt.

I stället bör du komma åt följande åtgärder via

ResourceManagementClient's

<xref:resource_groups> Attributet.

Arv
builtins.object
ResourceGroupsOperations

Konstruktor

ResourceGroupsOperations(*args, **kwargs)

Metoder

begin_delete

Tar bort en resursgrupp.

När du tar bort en resursgrupp tas även alla dess resurser bort. Om du tar bort en resursgrupp tas alla dess malldistributioner och för närvarande lagrade åtgärder bort.
begin_export_template

Registrerar den angivna resursgruppen som en mall.
check_existence

Kontrollerar om det finns en resursgrupp.
create_or_update

Skapar eller uppdaterar en resursgrupp.
get

Hämtar en resursgrupp.
list

Hämtar alla resursgrupper för en prenumeration.
update

Uppdateringar en resursgrupp.

Resursgrupper kan uppdateras via en enkel PATCH-åtgärd till en gruppadress. Formatet för begäran är detsamma som för att skapa en resursgrupp. Om ett fält är ospecificerat behålls det aktuella värdet.

begin_delete

Tar bort en resursgrupp.

När du tar bort en resursgrupp tas även alla dess resurser bort. Om du tar bort en resursgrupp tas alla dess malldistributioner och för närvarande lagrade åtgärder bort.

begin_delete(resource_group_name: str, force_deletion_types: str | None = None, **kwargs: Any) -> LROPoller[None]

Parametrar

resource_group_name
str
Obligatorisk

Namnet på den resursgrupp som ska tas bort. Namnet är skiftlägesokänsligt. Krävs.

force_deletion_types
str
Obligatorisk

De resurstyper som du vill framtvinga borttagning. För närvarande stöds endast följande: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets. Standardvärdet är Ingen.

cls
callable

En anpassad typ eller funktion som skickas direktsvaret

continuation_token
str

En fortsättningstoken för att starta om en poller från ett sparat tillstånd.

polling
bool eller PollingMethod

Som standard är avsökningsmetoden ARMPolling. Skicka in Falskt för att den här åtgärden inte ska avsökas eller skicka in ditt eget initierade avsökningsobjekt för en personlig avsökningsstrategi.

polling_interval
int

Standardväntetid mellan två omröstningar för LRO-åtgärder om det inte finns någon Retry-After huvud.

Returer

En instans av LROPoller som returnerar antingen None eller resultatet av cls(response)

Returtyp

LROPoller[None]

Undantag

HttpResponseError

begin_export_template

Registrerar den angivna resursgruppen som en mall.

begin_export_template(resource_group_name: str, parameters: _models.ExportTemplateRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ResourceGroupExportResult]

Parametrar

resource_group_name
str
Obligatorisk

Namnet på resursgruppen. Namnet är skiftlägesokänsligt. Krävs.

parameters
ExportTemplateRequest eller IO
Obligatorisk

Parametrar för att exportera mallen. Är antingen en ExportTemplateRequest-typ eller en I/O-typ. Krävs.

content_type
str

Innehållstyp för brödtextparameter. Kända värden är: "application/json". Standardvärdet är Ingen.

cls
callable

En anpassad typ eller funktion som skickas direktsvaret

continuation_token
str

En fortsättningstoken för att starta om en poller från ett sparat tillstånd.

polling
bool eller PollingMethod

Som standard är avsökningsmetoden ARMPolling. Skicka in Falskt för att den här åtgärden inte ska avsökas eller skicka in ditt eget initierade avsökningsobjekt för en personlig avsökningsstrategi.

polling_interval
int

Standardväntetid mellan två omröstningar för LRO-åtgärder om det inte finns någon Retry-After huvud.

Returer

En instans av LROPoller som antingen returnerar ResourceGroupExportResult eller resultatet av cls(svar)

Returtyp

LROPoller[ResourceGroupExportResult]

Undantag

HttpResponseError

check_existence

Kontrollerar om det finns en resursgrupp.

check_existence(resource_group_name: str, **kwargs: Any) -> bool

Parametrar

resource_group_name
str
Obligatorisk

Namnet på den resursgrupp som ska kontrolleras. Namnet är skiftlägesokänsligt. Krävs.

cls
callable

En anpassad typ eller funktion som skickas direktsvaret

Returer

bool eller resultatet av cls(svar)

Returtyp

bool

Undantag

HttpResponseError

create_or_update

Skapar eller uppdaterar en resursgrupp.

create_or_update(resource_group_name: str, parameters: _models.ResourceGroup, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroup

Parametrar

resource_group_name
str
Obligatorisk

Namnet på resursgruppen som ska skapas eller uppdateras. Kan innehålla alfanumeriska, understreck, parenteser, bindestreck, punkt (utom i slutet) och Unicode-tecken som matchar de tillåtna tecknen. Krävs.

parameters
ResourceGroup eller IO
Obligatorisk

Parametrar som anges för att skapa eller uppdatera en resursgrupp. Är antingen en ResourceGroup-typ eller en I/O-typ. Krävs.

content_type
str

Innehållstyp för brödtextparameter. Kända värden är: "application/json". Standardvärdet är Ingen.

cls
callable

En anpassad typ eller funktion som skickas direktsvaret

Returer

ResourceGroup eller resultatet av cls(response)

Returtyp

ResourceGroup

Undantag

HttpResponseError

get

Hämtar en resursgrupp.

get(resource_group_name: str, **kwargs: Any) -> ResourceGroup

Parametrar

resource_group_name
str
Obligatorisk

Namnet på resursgruppen som ska hämtas. Namnet är skiftlägesokänsligt. Krävs.

cls
callable

En anpassad typ eller funktion som skickas direktsvaret

Returer

ResourceGroup eller resultatet av cls(response)

Returtyp

ResourceGroup

Undantag

HttpResponseError

list

Hämtar alla resursgrupper för en prenumeration.

list(filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[ResourceGroup]

Parametrar

filter
str
Obligatorisk

Filtret som ska tillämpas på åtgärden.:code:
:code:>><<<br>Du kan filtrera efter taggnamn och värden. Om du till exempel vill filtrera efter ett taggnamn och -värde använder du $filter=tagName eq 'tag1' och tagValue eq 'Value1'. Standardvärdet är Ingen.

top
int
Obligatorisk

Antalet resultat som ska returneras. Om null skickas returnerar alla resursgrupper. Standardvärdet är Ingen.

cls
callable

En anpassad typ eller funktion som skickas direktsvaret

Returer

En iterator som en instans av ResourceGroup eller resultatet av cls(response)

Returtyp

ItemPaged[ResourceGroup]

Undantag

HttpResponseError

update

Uppdateringar en resursgrupp.

Resursgrupper kan uppdateras via en enkel PATCH-åtgärd till en gruppadress. Formatet för begäran är detsamma som för att skapa en resursgrupp. Om ett fält är ospecificerat behålls det aktuella värdet.

update(resource_group_name: str, parameters: _models.ResourceGroupPatchable, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroup

Parametrar

resource_group_name
str
Obligatorisk

Namnet på resursgruppen som ska uppdateras. Namnet är skiftlägesokänsligt. Krävs.

parameters
ResourceGroupPatchable eller IO
Obligatorisk

Parametrar som tillhandahålls för att uppdatera en resursgrupp. Är antingen en ResourceGroupPatchable-typ eller en I/O-typ. Krävs.

content_type
str

Innehållstyp för brödtextparameter. Kända värden är: "application/json". Standardvärdet är Ingen.

cls
callable

En anpassad typ eller funktion som skickas direktsvaret

Returer

ResourceGroup eller resultatet av cls(response)

Returtyp

ResourceGroup

Undantag

HttpResponseError

Attribut

models 

models = <module 'azure.mgmt.resource.resources.v2021_04_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2021_04_01\\models\\__init__.py'>