Freigeben über


Domain Klasse

EventGrid-Domäne.

Variablen werden nur vom Server aufgefüllt und beim Senden einer Anforderung ignoriert.

Zum Senden an Azure müssen alle erforderlichen Parameter aufgefüllt werden.

Vererbung
azure.mgmt.eventgrid.models._models_py3.TrackedResource
Domain

Konstruktor

Domain(*, location: str, tags: Dict[str, str] | None = None, sku: _models.ResourceSku | None = None, identity: _models.IdentityInfo | None = None, minimum_tls_version_allowed: str | _models.TlsVersion | None = None, input_schema: str | _models.InputSchema | None = None, event_type_info: _models.EventTypeInfo | None = None, input_schema_mapping: _models.InputSchemaMapping | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, inbound_ip_rules: List[_models.InboundIpRule] | None = None, disable_local_auth: bool = False, auto_create_topic_with_first_subscription: bool = True, auto_delete_topic_with_last_subscription: bool = True, data_residency_boundary: str | _models.DataResidencyBoundary | None = None, **kwargs: Any)

Keyword-Only Parameters

location
str

Speicherort der Ressource. Erforderlich.

tags
dict[str, str]

Tags der Ressource.

sku
ResourceSku

Der SKU-Tarif für die Event Grid-Domänenressource.

identity
IdentityInfo

Identitätsinformationen für die Event Grid-Domänenressource.

minimum_tls_version_allowed
str oder TlsVersion

Minimale TLS-Version des Herausgebers, die in dieser Domäne veröffentlicht werden darf. Bekannte Werte sind "1.0", "1.1" und "1.2".

input_schema
str oder InputSchema

Dadurch wird das Format bestimmt, das Event Grid für eingehende Ereignisse erwarten sollte, die in der Event Grid-Domänenressource veröffentlicht werden. Bekannte Werte sind "EventGridSchema", "CustomEventSchema" und "CloudEventSchemaV1_0".

event_type_info
EventTypeInfo

Ereignistypinformationen für die Domäne. Diese Informationen werden vom Herausgeber bereitgestellt und können vom Abonnenten verwendet werden, um verschiedene Arten von Ereignissen anzuzeigen, die veröffentlicht werden.

input_schema_mapping
InputSchemaMapping

Informationen zum InputSchemaMapping, in dem die Informationen zur Zuordnungsereignisnutzlast angegeben wurden.

public_network_access
str oder PublicNetworkAccess

Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Sie können weitere Einschränkungen auf bestimmte IP-Adressen durchführen, indem Sie konfigurieren <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />. Bekannte Werte sind: "Enabled", "Disabled" und "SecuredByPerimeter".

inbound_ip_rules
list[InboundIpRule]

Dies kann verwendet werden, um den Datenverkehr von bestimmten IP-Adressen anstelle aller IP-Adressen einzuschränken. Hinweis: Diese werden nur berücksichtigt, wenn PublicNetworkAccess aktiviert ist.

disable_local_auth
bool

Dieser boolesche Wert wird verwendet, um die lokale Authentifizierung zu aktivieren oder zu deaktivieren. Der Standardwert ist false. Wenn die Eigenschaft auf true festgelegt ist, wird nur das AAD-Token für die Authentifizierung verwendet, wenn der Benutzer die Veröffentlichung in der Domäne erlaubt.

auto_create_topic_with_first_subscription
bool
Standardwert: True

Dieser Boolesche Wert wird verwendet, um den Erstellungsmechanismus für "alle" der Event Grid-Domänenthemen anzugeben, die dieser Event Grid-Domänenressource zugeordnet sind. In diesem Kontext kann die Erstellung eines Domänenthemas automatisch verwaltet (wenn true) oder selbstverwaltet (wenn false) erfolgen. Der Standardwert dieser Eigenschaft ist „TRUE“. Wenn diese Eigenschaft null oder auf true festgelegt ist, ist Event Grid für das automatische Erstellen des Domänenthemas verantwortlich, wenn das erste Ereignisabonnement im Bereich des Domänenthemas erstellt wird. Wenn diese Eigenschaft auf false festgelegt ist, muss für das Erstellen des ersten Ereignisabonnements ein Domänenthema durch den Benutzer erstellt werden. Der Selbstverwaltungsmodus kann verwendet werden, wenn der Benutzer die vollständige Kontrolle über die Erstellung des Domänenthemas haben möchte, während der automatisch verwaltete Modus die Flexibilität bietet, weniger Vorgänge auszuführen und weniger Ressourcen durch den Benutzer zu verwalten. Beachten Sie außerdem, dass der Benutzer im automatisch verwalteten Erstellungsmodus bei Bedarf das Domänenthema bei Bedarf erstellen kann.

auto_delete_topic_with_last_subscription
bool
Standardwert: True

Dieser boolesche Wert wird verwendet, um den Löschmechanismus für "alle" event Grid-Domänenthemen anzugeben, die dieser Event Grid-Domänenressource zugeordnet sind. In diesem Kontext kann das Löschen eines Domänenthemas automatisch verwaltet (wenn true) oder selbstverwaltet (wenn false) sein. Der Standardwert dieser Eigenschaft ist „TRUE“. Wenn diese Eigenschaft auf true festgelegt ist, ist Event Grid für das automatische Löschen des Domänenthemas verantwortlich, wenn das letzte Ereignisabonnement im Bereich des Domänenthemas gelöscht wird. Wenn diese Eigenschaft auf false festgelegt ist, muss der Benutzer das Domänenthema manuell löschen, wenn es nicht mehr benötigt wird (z. B. wenn das letzte Ereignisabonnement gelöscht und die Ressource bereinigt werden muss). Der Selbstverwaltungsmodus kann verwendet werden, wenn der Benutzer die vollständige Kontrolle darüber haben möchte, wann das Domänenthema gelöscht werden muss, während der automatisch verwaltete Modus die Flexibilität bietet, weniger Vorgänge auszuführen und weniger Ressourcen durch den Benutzer zu verwalten.

data_residency_boundary
str oder DataResidencyBoundary

Data Residency Begrenzung der Ressource. Bekannte Werte sind "WithinGeopair" und "WithinRegion".

Variablen

id
str

Vollqualifizierter Bezeichner der Ressource.

name
str

Der Name der Ressource.

type
str

Der Typ der Ressource.

location
str

Speicherort der Ressource. Erforderlich.

tags
dict[str, str]

Tags der Ressource.

sku
ResourceSku

Der SKU-Tarif für die Event Grid-Domänenressource.

identity
IdentityInfo

Identitätsinformationen für die Event Grid-Domänenressource.

system_data
SystemData

Die Systemmetadaten im Zusammenhang mit der Event Grid-Domänenressource.

private_endpoint_connections
list[PrivateEndpointConnection]
provisioning_state
str oder DomainProvisioningState

Bereitstellungsstatus der Event Grid-Domänenressource. Bekannte Werte sind: "Creating", "Updating", "Deleting", "Succeeded", "Canceled" und "Failed".

minimum_tls_version_allowed
str oder TlsVersion

Minimale TLS-Version des Herausgebers, die in dieser Domäne veröffentlicht werden darf. Bekannte Werte sind "1.0", "1.1" und "1.2".

endpoint
str

Endpunkt für die Event Grid-Domänenressource, die zum Veröffentlichen der Ereignisse verwendet wird.

input_schema
str oder InputSchema

Dadurch wird das Format bestimmt, das Event Grid für eingehende Ereignisse erwarten sollte, die in der Event Grid-Domänenressource veröffentlicht werden. Bekannte Werte sind "EventGridSchema", "CustomEventSchema" und "CloudEventSchemaV1_0".

event_type_info
EventTypeInfo

Ereignistypinformationen für die Domäne. Diese Informationen werden vom Herausgeber bereitgestellt und können vom Abonnenten verwendet werden, um verschiedene Arten von Ereignissen anzuzeigen, die veröffentlicht werden.

input_schema_mapping
InputSchemaMapping

Informationen zum InputSchemaMapping, in dem die Informationen zur Zuordnungsereignisnutzlast angegeben wurden.

metric_resource_id
str

Metrikressourcen-ID für die Event Grid-Domänenressource.

public_network_access
str oder PublicNetworkAccess

Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist es aktiviert. Sie können weitere Einschränkungen auf bestimmte IP-Adressen durchführen, indem Sie konfigurieren <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />. Bekannte Werte sind: "Enabled", "Disabled" und "SecuredByPerimeter".

inbound_ip_rules
list[InboundIpRule]

Dies kann verwendet werden, um den Datenverkehr von bestimmten IP-Adressen anstelle aller IP-Adressen einzuschränken. Hinweis: Diese werden nur berücksichtigt, wenn PublicNetworkAccess aktiviert ist.

disable_local_auth
bool

Dieser boolesche Wert wird verwendet, um die lokale Authentifizierung zu aktivieren oder zu deaktivieren. Der Standardwert ist false. Wenn die Eigenschaft auf true festgelegt ist, wird nur das AAD-Token für die Authentifizierung verwendet, wenn der Benutzer die Veröffentlichung in der Domäne erlaubt.

auto_create_topic_with_first_subscription
bool

Dieser Boolesche Wert wird verwendet, um den Erstellungsmechanismus für "alle" der Event Grid-Domänenthemen anzugeben, die dieser Event Grid-Domänenressource zugeordnet sind. In diesem Kontext kann die Erstellung eines Domänenthemas automatisch verwaltet (wenn true) oder selbstverwaltet (wenn false) erfolgen. Der Standardwert dieser Eigenschaft ist „TRUE“. Wenn diese Eigenschaft null oder auf true festgelegt ist, ist Event Grid für das automatische Erstellen des Domänenthemas verantwortlich, wenn das erste Ereignisabonnement im Bereich des Domänenthemas erstellt wird. Wenn diese Eigenschaft auf false festgelegt ist, muss für das Erstellen des ersten Ereignisabonnements ein Domänenthema durch den Benutzer erstellt werden. Der Selbstverwaltungsmodus kann verwendet werden, wenn der Benutzer die vollständige Kontrolle über die Erstellung des Domänenthemas haben möchte, während der automatisch verwaltete Modus die Flexibilität bietet, weniger Vorgänge auszuführen und weniger Ressourcen durch den Benutzer zu verwalten. Beachten Sie außerdem, dass der Benutzer im automatisch verwalteten Erstellungsmodus bei Bedarf das Domänenthema bei Bedarf erstellen kann.

auto_delete_topic_with_last_subscription
bool

Dieser boolesche Wert wird verwendet, um den Löschmechanismus für "alle" event Grid-Domänenthemen anzugeben, die dieser Event Grid-Domänenressource zugeordnet sind. In diesem Kontext kann das Löschen eines Domänenthemas automatisch verwaltet (wenn true) oder selbstverwaltet (wenn false) sein. Der Standardwert dieser Eigenschaft ist „TRUE“. Wenn diese Eigenschaft auf true festgelegt ist, ist Event Grid für das automatische Löschen des Domänenthemas verantwortlich, wenn das letzte Ereignisabonnement im Bereich des Domänenthemas gelöscht wird. Wenn diese Eigenschaft auf false festgelegt ist, muss der Benutzer das Domänenthema manuell löschen, wenn es nicht mehr benötigt wird (z. B. wenn das letzte Ereignisabonnement gelöscht und die Ressource bereinigt werden muss). Der Selbstverwaltungsmodus kann verwendet werden, wenn der Benutzer die vollständige Kontrolle darüber haben möchte, wann das Domänenthema gelöscht werden muss, während der automatisch verwaltete Modus die Flexibilität bietet, weniger Vorgänge auszuführen und weniger Ressourcen durch den Benutzer zu verwalten.

data_residency_boundary
str oder DataResidencyBoundary

Data Residency Begrenzung der Ressource. Bekannte Werte sind "WithinGeopair" und "WithinRegion".