EventGridDomain Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
EventGridDomain.
public class EventGridDomain : Azure.Provisioning.Primitives.ProvisionableResource
public class EventGridDomain : Azure.Provisioning.Primitives.Resource
type EventGridDomain = class
inherit ProvisionableResource
type EventGridDomain = class
inherit Resource
Public Class EventGridDomain
Inherits ProvisionableResource
Public Class EventGridDomain
Inherits Resource
- Inheritance
- Inheritance
Constructors
EventGridDomain(String, String) |
Creates a new EventGridDomain. |
Properties
AutoCreateTopicWithFirstSubscription |
This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed. |
AutoDeleteTopicWithLastSubscription |
This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. |
BicepIdentifier |
Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores. (Inherited from NamedProvisionableConstruct) |
DataResidencyBoundary |
Data Residency Boundary of the resource. |
DependsOn |
Declares explicit dependencies on other resources. (Inherited from ProvisionableResource) |
DependsOn |
Declares explicit dependencies on other resources. (Inherited from Resource) |
Endpoint |
Endpoint for the Event Grid Domain Resource which is used for publishing the events. |
EventTypeInfo |
Event Type Information for the domain. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published. |
Id |
Gets the Id. |
IdentifierName |
Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores. (Inherited from NamedProvisioningConstruct) |
Identity |
Identity information for the Event Grid Domain resource. |
InboundIPRules |
This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled. |
InputSchema |
This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. |
InputSchemaMapping |
Information about the InputSchemaMapping which specified the info about mapping event payload. Please note Azure.ResourceManager.EventGrid.Models.EventGridInputSchemaMapping is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include Azure.ResourceManager.EventGrid.Models.EventGridJsonInputSchemaMapping. |
IsExistingResource |
Gets whether this is referencing an existing resource or we're defining a new resource. (Inherited from ProvisionableResource) |
IsExistingResource |
Gets whether this is referencing an existing resource or we're defining a new resource. (Inherited from Resource) |
IsLocalAuthDisabled |
This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain. |
Location |
Gets or sets the Location. |
MetricResourceId |
Metric resource id for the Event Grid Domain Resource. |
MinimumTlsVersionAllowed |
Minimum TLS version of the publisher allowed to publish to this domain. |
Name |
Name of the domain. |
PrivateEndpointConnections |
List of private endpoint connections. |
ProvisioningState |
Provisioning state of the Event Grid Domain Resource. |
PublicNetworkAccess |
This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" /> |
ResourceType |
Gets the type of the resource. (Inherited from ProvisionableResource) |
ResourceType |
Gets the type of the resource. (Inherited from Resource) |
ResourceVersion |
Gets or sets the version of the resource. (Inherited from ProvisionableResource) |
ResourceVersion |
Gets or sets the version of the resource. (Inherited from Resource) |
SkuName |
The Sku name of the resource. The possible values are: Basic or Premium. |
SystemData |
Gets the SystemData. |
Tags |
Gets or sets the Tags. |
Methods
AssignOrReplace<T>(T, T) | (Inherited from ProvisionableConstruct) |
Build(ProvisioningBuildOptions) |
Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly. (Inherited from ProvisionableResource) |
Build(ProvisioningContext) |
Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly. (Inherited from Resource) |
Compile() |
Compile the resource into a set of Bicep statements. (Inherited from ProvisionableResource) |
Compile() |
Compile the resource into a set of Bicep statements. (Inherited from Resource) |
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean) | (Inherited from ProvisionableConstruct) |
DefineListProperty<T>(String, String[], Boolean, Boolean) | (Inherited from ProvisionableConstruct) |
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String) | (Inherited from ProvisionableConstruct) |
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String) | (Inherited from ProvisionableConstruct) |
DefineProvisionableProperties() |
Define all the provisionable properties of EventGridDomain. |
DefineResource<T>(String, String[], Boolean, Boolean, T) | (Inherited from ProvisionableResource) |
FromExisting(String, String) |
Creates a reference to an existing EventGridDomain. |
GetProvisionableResources() |
Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable) |
GetResources() |
Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable) |
Initialize() |
Initialize this construct. (Inherited from ProvisionableConstruct) |
OverrideWithExpression(BicepExpression) | (Inherited from ProvisionableConstruct) |
OverrideWithExpression(Expression) |
Set this construct to represent the result of an expression. This is
primarily meant to be called via |
Resolve(ProvisioningBuildOptions) |
Resolve any resources or properties that were not explicitly specified. (Inherited from ProvisionableConstruct) |
Resolve(ProvisioningBuildOptions) |
Resolve any resources or properties that were not explicitly specified. (Inherited from Provisionable) |
Resolve(ProvisioningContext) |
Resolve any resources or properties that were not explicitly specified. (Inherited from Provisionable) |
Resolve(ProvisioningContext) |
Resolve any resources or properties that were not explicitly specified. (Inherited from ProvisioningConstruct) |
Validate(ProvisioningBuildOptions) |
Validate the presence of any required members. (Inherited from ProvisionableResource) |
Validate(ProvisioningBuildOptions) |
Validate the presence of any required members. (Inherited from Provisionable) |
Validate(ProvisioningContext) |
Validate the presence of any required members. (Inherited from Provisionable) |
Validate(ProvisioningContext) |
Validate the presence of any required members. (Inherited from Resource) |
Explicit Interface Implementations
IBicepValue.Assign(IBicepValue) |
Assign a value to this property. (Inherited from ProvisionableConstruct) |
IBicepValue.Compile() |
Compile this value to a Bicep expression. (Inherited from ProvisionableConstruct) |
IBicepValue.Expression |
Gets the expression for this value if it's not a literal. (Inherited from ProvisionableConstruct) |
IBicepValue.IsEmpty |
Gets whether this value is unset or empty. (Inherited from ProvisionableConstruct) |
IBicepValue.IsOutput |
Tracks whether this is an output only property. (Inherited from ProvisionableConstruct) |
IBicepValue.IsRequired |
Tracks whether this property is required. (Inherited from ProvisionableConstruct) |
IBicepValue.IsSecure |
Tracks whether this contains a secure value. (Inherited from ProvisionableConstruct) |
IBicepValue.Kind |
Gets the kind of this value (a literal value, an expression, or it's unset). (Inherited from ProvisionableConstruct) |
IBicepValue.LiteralValue |
Get the value of this expression, if it's literal. (Inherited from ProvisionableConstruct) |
IBicepValue.Self |
Gets information about where this value was defined. (Inherited from ProvisionableConstruct) |
IBicepValue.SetReadOnly() |
Make this value readonly. (Inherited from ProvisionableConstruct) |
IBicepValue.Source |
Gets information about where this value was assigned from. (Inherited from ProvisionableConstruct) |