Dela via


DomainsOperations Klass

Varning

Instansiera INTE den här klassen direkt.

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

EventGridManagementClient's

<xref:domains> Attributet.

Arv
builtins.object
DomainsOperations

Konstruktor

DomainsOperations(*args, **kwargs)

Metoder

begin_create_or_update

Skapa eller uppdatera en domän.

Skapar eller uppdaterar asynkront en ny domän med de angivna parametrarna.

begin_delete

Ta bort en domän.

Ta bort befintlig domän.

begin_update

Uppdatera en domän.

Asynkront uppdaterar en domän med de angivna parametrarna.

get

Hämta en domän.

Hämta egenskaper för en domän.

list_by_resource_group

Lista domäner under en resursgrupp.

Visa en lista över alla domäner under en resursgrupp.

list_by_subscription

Lista domäner under en Azure-prenumeration.

Visa en lista över alla domäner under en Azure-prenumeration.

list_shared_access_keys

Visa en lista över nycklar för en domän.

Visa en lista över de två nycklar som används för att publicera till en domän.

regenerate_key

Återskapa nyckeln för en domän.

Återskapa en delad åtkomstnyckel för en domän.

begin_create_or_update

Skapa eller uppdatera en domän.

Skapar eller uppdaterar asynkront en ny domän med de angivna parametrarna.

begin_create_or_update(resource_group_name: str, domain_name: str, domain_info: _models.Domain, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Domain]

Parametrar

resource_group_name
str
Obligatorisk

Namnet på resursgruppen i användarens prenumeration. Krävs.

domain_name
str
Obligatorisk

Namnet på domänen. Krävs.

domain_info
Domain eller IO
Obligatorisk

Domäninformation. Är antingen en domäntyp 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öka 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 Domän eller resultatet av cls(response)

Returtyp

Undantag

begin_delete

Ta bort en domän.

Ta bort befintlig domän.

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

Parametrar

resource_group_name
str
Obligatorisk

Namnet på resursgruppen i användarens prenumeration. Krävs.

domain_name
str
Obligatorisk

Namnet på domänen. Krävs.

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

Undantag

begin_update

Uppdatera en domän.

Asynkront uppdaterar en domän med de angivna parametrarna.

begin_update(resource_group_name: str, domain_name: str, domain_update_parameters: _models.DomainUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Domain]

Parametrar

resource_group_name
str
Obligatorisk

Namnet på resursgruppen i användarens prenumeration. Krävs.

domain_name
str
Obligatorisk

Namnet på domänen. Krävs.

domain_update_parameters
DomainUpdateParameters eller IO
Obligatorisk

Information om domänuppdatering. Är antingen en DomainUpdateParameters-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öka 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 Domän eller resultatet av cls(response)

Returtyp

Undantag

get

Hämta en domän.

Hämta egenskaper för en domän.

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

Parametrar

resource_group_name
str
Obligatorisk

Namnet på resursgruppen i användarens prenumeration. Krävs.

domain_name
str
Obligatorisk

Namnet på domänen. Krävs.

cls
callable

En anpassad typ eller funktion som skickas direktsvaret

Returer

Domän eller resultatet av cls(svar)

Returtyp

Undantag

list_by_resource_group

Lista domäner under en resursgrupp.

Visa en lista över alla domäner under en resursgrupp.

list_by_resource_group(resource_group_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[Domain]

Parametrar

resource_group_name
str
Obligatorisk

Namnet på resursgruppen i användarens prenumeration. Krävs.

filter
str
Obligatorisk

Frågan som används för att filtrera sökresultaten med OData-syntax. Filtrering tillåts endast för egenskapen "name" och med ett begränsat antal OData-åtgärder. Dessa åtgärder är: funktionen "contains" samt följande logiska åtgärder: inte, och eller eq (för lika med) och ne (för inte lika med). Inga aritmetiska åtgärder stöds. Följande är ett giltigt filterexempel: $filter=contains(namE, 'PATTERN') och name ne 'PATTERN-1'. Följande är inte ett giltigt filterexempel: $filter=location eq 'westus'. Standardvärdet är Ingen.

top
int
Obligatorisk

Antalet resultat som ska returneras per sida för liståtgärden. Giltigt intervall för den översta parametern är 1 till 100. Om inget anges är standardantalet resultat som ska returneras 20 objekt per sida. Standardvärdet är Ingen.

cls
callable

En anpassad typ eller funktion som skickas direktsvaret

Returer

En iterator som en instans av domänen eller resultatet av cls(svar)

Returtyp

Undantag

list_by_subscription

Lista domäner under en Azure-prenumeration.

Visa en lista över alla domäner under en Azure-prenumeration.

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

Parametrar

filter
str
Obligatorisk

Frågan som används för att filtrera sökresultaten med OData-syntax. Filtrering tillåts endast för egenskapen "name" och med ett begränsat antal OData-åtgärder. Dessa åtgärder är: funktionen "contains" samt följande logiska åtgärder: inte, och eller eq (för lika med) och ne (för inte lika med). Inga aritmetiska åtgärder stöds. Följande är ett giltigt filterexempel: $filter=contains(namE, 'PATTERN') och name ne 'PATTERN-1'. Följande är inte ett giltigt filterexempel: $filter=location eq 'westus'. Standardvärdet är Ingen.

top
int
Obligatorisk

Antalet resultat som ska returneras per sida för liståtgärden. Giltigt intervall för den översta parametern är 1 till 100. Om inget anges är standardantalet resultat som ska returneras 20 objekt per sida. Standardvärdet är Ingen.

cls
callable

En anpassad typ eller funktion som skickas direktsvaret

Returer

En iterator som en instans av domänen eller resultatet av cls(svar)

Returtyp

Undantag

list_shared_access_keys

Visa en lista över nycklar för en domän.

Visa en lista över de två nycklar som används för att publicera till en domän.

list_shared_access_keys(resource_group_name: str, domain_name: str, **kwargs: Any) -> DomainSharedAccessKeys

Parametrar

resource_group_name
str
Obligatorisk

Namnet på resursgruppen i användarens prenumeration. Krävs.

domain_name
str
Obligatorisk

Namnet på domänen. Krävs.

cls
callable

En anpassad typ eller funktion som skickas direktsvaret

Returer

DomainSharedAccessKeys eller resultatet av cls(response)

Returtyp

Undantag

regenerate_key

Återskapa nyckeln för en domän.

Återskapa en delad åtkomstnyckel för en domän.

regenerate_key(resource_group_name: str, domain_name: str, regenerate_key_request: _models.DomainRegenerateKeyRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DomainSharedAccessKeys

Parametrar

resource_group_name
str
Obligatorisk

Namnet på resursgruppen i användarens prenumeration. Krävs.

domain_name
str
Obligatorisk

Namnet på domänen. Krävs.

regenerate_key_request
DomainRegenerateKeyRequest eller IO
Obligatorisk

Begär brödtext för att återskapa nyckeln. Är antingen en DomainRegenerateKeyRequest-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

DomainSharedAccessKeys eller resultatet av cls(response)

Returtyp

Undantag

Attribut

models

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