Azure Classic v5.43.0, May 6 23
Azure Classic v5.43.0, May 6 23
azure.eventgrid.getDomain
Explore with Pulumi AI
Use this data source to access information about an existing EventGrid Domain
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = Azure.EventGrid.GetDomain.Invoke(new()
{
Name = "my-eventgrid-domain",
ResourceGroupName = "example-resources",
});
return new Dictionary<string, object?>
{
["eventgridDomainMappingTopic"] = example.Apply(getDomainResult => getDomainResult.InputMappingFields[0]?.Topic),
};
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/eventgrid"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := eventgrid.LookupDomain(ctx, &eventgrid.LookupDomainArgs{
Name: "my-eventgrid-domain",
ResourceGroupName: "example-resources",
}, nil)
if err != nil {
return err
}
ctx.Export("eventgridDomainMappingTopic", example.InputMappingFields[0].Topic)
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.eventgrid.EventgridFunctions;
import com.pulumi.azure.eventgrid.inputs.GetDomainArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = EventgridFunctions.getDomain(GetDomainArgs.builder()
.name("my-eventgrid-domain")
.resourceGroupName("example-resources")
.build());
ctx.export("eventgridDomainMappingTopic", example.applyValue(getDomainResult -> getDomainResult.inputMappingFields()[0].topic()));
}
}
import pulumi
import pulumi_azure as azure
example = azure.eventgrid.get_domain(name="my-eventgrid-domain",
resource_group_name="example-resources")
pulumi.export("eventgridDomainMappingTopic", example.input_mapping_fields[0].topic)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.eventgrid.getDomain({
name: "my-eventgrid-domain",
resourceGroupName: "example-resources",
});
export const eventgridDomainMappingTopic = example.then(example => example.inputMappingFields?.[0]?.topic);
variables:
example:
fn::invoke:
Function: azure:eventgrid:getDomain
Arguments:
name: my-eventgrid-domain
resourceGroupName: example-resources
outputs:
eventgridDomainMappingTopic: ${example.inputMappingFields[0].topic}
Using getDomain
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getDomain(args: GetDomainArgs, opts?: InvokeOptions): Promise<GetDomainResult>
function getDomainOutput(args: GetDomainOutputArgs, opts?: InvokeOptions): Output<GetDomainResult>
def get_domain(inbound_ip_rules: Optional[Sequence[GetDomainInboundIpRule]] = None,
name: Optional[str] = None,
public_network_access_enabled: Optional[bool] = None,
resource_group_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
opts: Optional[InvokeOptions] = None) -> GetDomainResult
def get_domain_output(inbound_ip_rules: Optional[pulumi.Input[Sequence[pulumi.Input[GetDomainInboundIpRuleArgs]]]] = None,
name: Optional[pulumi.Input[str]] = None,
public_network_access_enabled: Optional[pulumi.Input[bool]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDomainResult]
func LookupDomain(ctx *Context, args *LookupDomainArgs, opts ...InvokeOption) (*LookupDomainResult, error)
func LookupDomainOutput(ctx *Context, args *LookupDomainOutputArgs, opts ...InvokeOption) LookupDomainResultOutput
> Note: This function is named LookupDomain
in the Go SDK.
public static class GetDomain
{
public static Task<GetDomainResult> InvokeAsync(GetDomainArgs args, InvokeOptions? opts = null)
public static Output<GetDomainResult> Invoke(GetDomainInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure:eventgrid/getDomain:getDomain
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
The name of the EventGrid Domain resource.
- Resource
Group stringName The name of the resource group in which the EventGrid Domain exists.
- Inbound
Ip List<GetRules Domain Inbound Ip Rule> One or more
inbound_ip_rule
blocks as defined below.- Public
Network boolAccess Enabled Whether or not public network access is allowed for this server.
- Dictionary<string, string>
A mapping of tags assigned to the EventGrid Domain.
- Name string
The name of the EventGrid Domain resource.
- Resource
Group stringName The name of the resource group in which the EventGrid Domain exists.
- Inbound
Ip []GetRules Domain Inbound Ip Rule One or more
inbound_ip_rule
blocks as defined below.- Public
Network boolAccess Enabled Whether or not public network access is allowed for this server.
- map[string]string
A mapping of tags assigned to the EventGrid Domain.
- name String
The name of the EventGrid Domain resource.
- resource
Group StringName The name of the resource group in which the EventGrid Domain exists.
- inbound
Ip List<GetRules Domain Inbound Ip Rule> One or more
inbound_ip_rule
blocks as defined below.- public
Network BooleanAccess Enabled Whether or not public network access is allowed for this server.
- Map<String,String>
A mapping of tags assigned to the EventGrid Domain.
- name string
The name of the EventGrid Domain resource.
- resource
Group stringName The name of the resource group in which the EventGrid Domain exists.
- inbound
Ip GetRules Domain Inbound Ip Rule[] One or more
inbound_ip_rule
blocks as defined below.- public
Network booleanAccess Enabled Whether or not public network access is allowed for this server.
- {[key: string]: string}
A mapping of tags assigned to the EventGrid Domain.
- name str
The name of the EventGrid Domain resource.
- resource_
group_ strname The name of the resource group in which the EventGrid Domain exists.
- inbound_
ip_ Sequence[Getrules Domain Inbound Ip Rule] One or more
inbound_ip_rule
blocks as defined below.- public_
network_ boolaccess_ enabled Whether or not public network access is allowed for this server.
- Mapping[str, str]
A mapping of tags assigned to the EventGrid Domain.
- name String
The name of the EventGrid Domain resource.
- resource
Group StringName The name of the resource group in which the EventGrid Domain exists.
- inbound
Ip List<Property Map>Rules One or more
inbound_ip_rule
blocks as defined below.- public
Network BooleanAccess Enabled Whether or not public network access is allowed for this server.
- Map<String>
A mapping of tags assigned to the EventGrid Domain.
getDomain Result
The following output properties are available:
- Endpoint string
The Endpoint associated with the EventGrid Domain.
- Id string
The provider-assigned unique ID for this managed resource.
- Input
Mapping List<GetDefault Values Domain Input Mapping Default Value> A
input_mapping_default_values
block as defined below.- Input
Mapping List<GetFields Domain Input Mapping Field> A
input_mapping_fields
block as defined below.- Input
Schema string The schema in which incoming events will be published to this domain. Possible values are
CloudEventSchemaV1_0
,CustomEventSchema
, orEventGridSchema
.- Location string
The Azure Region in which this EventGrid Domain exists.
- Name string
- Primary
Access stringKey The primary access key associated with the EventGrid Domain.
- Resource
Group stringName - Secondary
Access stringKey The secondary access key associated with the EventGrid Domain.
- Inbound
Ip List<GetRules Domain Inbound Ip Rule> One or more
inbound_ip_rule
blocks as defined below.- Public
Network boolAccess Enabled Whether or not public network access is allowed for this server.
- Dictionary<string, string>
A mapping of tags assigned to the EventGrid Domain.
- Endpoint string
The Endpoint associated with the EventGrid Domain.
- Id string
The provider-assigned unique ID for this managed resource.
- Input
Mapping []GetDefault Values Domain Input Mapping Default Value A
input_mapping_default_values
block as defined below.- Input
Mapping []GetFields Domain Input Mapping Field A
input_mapping_fields
block as defined below.- Input
Schema string The schema in which incoming events will be published to this domain. Possible values are
CloudEventSchemaV1_0
,CustomEventSchema
, orEventGridSchema
.- Location string
The Azure Region in which this EventGrid Domain exists.
- Name string
- Primary
Access stringKey The primary access key associated with the EventGrid Domain.
- Resource
Group stringName - Secondary
Access stringKey The secondary access key associated with the EventGrid Domain.
- Inbound
Ip []GetRules Domain Inbound Ip Rule One or more
inbound_ip_rule
blocks as defined below.- Public
Network boolAccess Enabled Whether or not public network access is allowed for this server.
- map[string]string
A mapping of tags assigned to the EventGrid Domain.
- endpoint String
The Endpoint associated with the EventGrid Domain.
- id String
The provider-assigned unique ID for this managed resource.
- input
Mapping List<GetDefault Values Domain Input Mapping Default Value> A
input_mapping_default_values
block as defined below.- input
Mapping List<GetFields Domain Input Mapping Field> A
input_mapping_fields
block as defined below.- input
Schema String The schema in which incoming events will be published to this domain. Possible values are
CloudEventSchemaV1_0
,CustomEventSchema
, orEventGridSchema
.- location String
The Azure Region in which this EventGrid Domain exists.
- name String
- primary
Access StringKey The primary access key associated with the EventGrid Domain.
- resource
Group StringName - secondary
Access StringKey The secondary access key associated with the EventGrid Domain.
- inbound
Ip List<GetRules Domain Inbound Ip Rule> One or more
inbound_ip_rule
blocks as defined below.- public
Network BooleanAccess Enabled Whether or not public network access is allowed for this server.
- Map<String,String>
A mapping of tags assigned to the EventGrid Domain.
- endpoint string
The Endpoint associated with the EventGrid Domain.
- id string
The provider-assigned unique ID for this managed resource.
- input
Mapping GetDefault Values Domain Input Mapping Default Value[] A
input_mapping_default_values
block as defined below.- input
Mapping GetFields Domain Input Mapping Field[] A
input_mapping_fields
block as defined below.- input
Schema string The schema in which incoming events will be published to this domain. Possible values are
CloudEventSchemaV1_0
,CustomEventSchema
, orEventGridSchema
.- location string
The Azure Region in which this EventGrid Domain exists.
- name string
- primary
Access stringKey The primary access key associated with the EventGrid Domain.
- resource
Group stringName - secondary
Access stringKey The secondary access key associated with the EventGrid Domain.
- inbound
Ip GetRules Domain Inbound Ip Rule[] One or more
inbound_ip_rule
blocks as defined below.- public
Network booleanAccess Enabled Whether or not public network access is allowed for this server.
- {[key: string]: string}
A mapping of tags assigned to the EventGrid Domain.
- endpoint str
The Endpoint associated with the EventGrid Domain.
- id str
The provider-assigned unique ID for this managed resource.
- input_
mapping_ Sequence[Getdefault_ values Domain Input Mapping Default Value] A
input_mapping_default_values
block as defined below.- input_
mapping_ Sequence[Getfields Domain Input Mapping Field] A
input_mapping_fields
block as defined below.- input_
schema str The schema in which incoming events will be published to this domain. Possible values are
CloudEventSchemaV1_0
,CustomEventSchema
, orEventGridSchema
.- location str
The Azure Region in which this EventGrid Domain exists.
- name str
- primary_
access_ strkey The primary access key associated with the EventGrid Domain.
- resource_
group_ strname - secondary_
access_ strkey The secondary access key associated with the EventGrid Domain.
- inbound_
ip_ Sequence[Getrules Domain Inbound Ip Rule] One or more
inbound_ip_rule
blocks as defined below.- public_
network_ boolaccess_ enabled Whether or not public network access is allowed for this server.
- Mapping[str, str]
A mapping of tags assigned to the EventGrid Domain.
- endpoint String
The Endpoint associated with the EventGrid Domain.
- id String
The provider-assigned unique ID for this managed resource.
- input
Mapping List<Property Map>Default Values A
input_mapping_default_values
block as defined below.- input
Mapping List<Property Map>Fields A
input_mapping_fields
block as defined below.- input
Schema String The schema in which incoming events will be published to this domain. Possible values are
CloudEventSchemaV1_0
,CustomEventSchema
, orEventGridSchema
.- location String
The Azure Region in which this EventGrid Domain exists.
- name String
- primary
Access StringKey The primary access key associated with the EventGrid Domain.
- resource
Group StringName - secondary
Access StringKey The secondary access key associated with the EventGrid Domain.
- inbound
Ip List<Property Map>Rules One or more
inbound_ip_rule
blocks as defined below.- public
Network BooleanAccess Enabled Whether or not public network access is allowed for this server.
- Map<String>
A mapping of tags assigned to the EventGrid Domain.
Supporting Types
GetDomainInboundIpRule
GetDomainInputMappingDefaultValue
- Data
Version string Specifies the default data version of the EventGrid Event associated with the domain.
- Event
Type string Specifies the default event type of the EventGrid Event associated with the domain.
- Subject string
Specifies the default subject of the EventGrid Event associated with the domain.
- Data
Version string Specifies the default data version of the EventGrid Event associated with the domain.
- Event
Type string Specifies the default event type of the EventGrid Event associated with the domain.
- Subject string
Specifies the default subject of the EventGrid Event associated with the domain.
- data
Version String Specifies the default data version of the EventGrid Event associated with the domain.
- event
Type String Specifies the default event type of the EventGrid Event associated with the domain.
- subject String
Specifies the default subject of the EventGrid Event associated with the domain.
- data
Version string Specifies the default data version of the EventGrid Event associated with the domain.
- event
Type string Specifies the default event type of the EventGrid Event associated with the domain.
- subject string
Specifies the default subject of the EventGrid Event associated with the domain.
- data_
version str Specifies the default data version of the EventGrid Event associated with the domain.
- event_
type str Specifies the default event type of the EventGrid Event associated with the domain.
- subject str
Specifies the default subject of the EventGrid Event associated with the domain.
- data
Version String Specifies the default data version of the EventGrid Event associated with the domain.
- event
Type String Specifies the default event type of the EventGrid Event associated with the domain.
- subject String
Specifies the default subject of the EventGrid Event associated with the domain.
GetDomainInputMappingField
- Data
Version string Specifies the default data version of the EventGrid Event associated with the domain.
- Event
Time string Specifies the event time of the EventGrid Event associated with the domain.
- Event
Type string Specifies the default event type of the EventGrid Event associated with the domain.
- Id string
Specifies the id of the EventGrid Event associated with the domain.
- Subject string
Specifies the default subject of the EventGrid Event associated with the domain.
- Topic string
Specifies the topic of the EventGrid Event associated with the domain.
- Data
Version string Specifies the default data version of the EventGrid Event associated with the domain.
- Event
Time string Specifies the event time of the EventGrid Event associated with the domain.
- Event
Type string Specifies the default event type of the EventGrid Event associated with the domain.
- Id string
Specifies the id of the EventGrid Event associated with the domain.
- Subject string
Specifies the default subject of the EventGrid Event associated with the domain.
- Topic string
Specifies the topic of the EventGrid Event associated with the domain.
- data
Version String Specifies the default data version of the EventGrid Event associated with the domain.
- event
Time String Specifies the event time of the EventGrid Event associated with the domain.
- event
Type String Specifies the default event type of the EventGrid Event associated with the domain.
- id String
Specifies the id of the EventGrid Event associated with the domain.
- subject String
Specifies the default subject of the EventGrid Event associated with the domain.
- topic String
Specifies the topic of the EventGrid Event associated with the domain.
- data
Version string Specifies the default data version of the EventGrid Event associated with the domain.
- event
Time string Specifies the event time of the EventGrid Event associated with the domain.
- event
Type string Specifies the default event type of the EventGrid Event associated with the domain.
- id string
Specifies the id of the EventGrid Event associated with the domain.
- subject string
Specifies the default subject of the EventGrid Event associated with the domain.
- topic string
Specifies the topic of the EventGrid Event associated with the domain.
- data_
version str Specifies the default data version of the EventGrid Event associated with the domain.
- event_
time str Specifies the event time of the EventGrid Event associated with the domain.
- event_
type str Specifies the default event type of the EventGrid Event associated with the domain.
- id str
Specifies the id of the EventGrid Event associated with the domain.
- subject str
Specifies the default subject of the EventGrid Event associated with the domain.
- topic str
Specifies the topic of the EventGrid Event associated with the domain.
- data
Version String Specifies the default data version of the EventGrid Event associated with the domain.
- event
Time String Specifies the event time of the EventGrid Event associated with the domain.
- event
Type String Specifies the default event type of the EventGrid Event associated with the domain.
- id String
Specifies the id of the EventGrid Event associated with the domain.
- subject String
Specifies the default subject of the EventGrid Event associated with the domain.
- topic String
Specifies the topic of the EventGrid Event associated with the domain.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.