Azure Native v1.103.0, Jun 2 23

Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

azure-native.eventgrid.getDomain

Explore with Pulumi AI

Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

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(domain_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetDomainResult
def get_domain_output(domain_name: Optional[pulumi.Input[str]] = None,
               resource_group_name: Optional[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-native:eventgrid:getDomain
  arguments:
    # arguments dictionary

The following arguments are supported:

DomainName string: Name of the domain.
ResourceGroupName string: The name of the resource group within the user's subscription.

DomainName string: Name of the domain.
ResourceGroupName string: The name of the resource group within the user's subscription.

domainName String: Name of the domain.
resourceGroupName String: The name of the resource group within the user's subscription.

domainName string: Name of the domain.
resourceGroupName string: The name of the resource group within the user's subscription.

domain_name str: Name of the domain.
resource_group_name str: The name of the resource group within the user's subscription.

domainName String: Name of the domain.
resourceGroupName String: The name of the resource group within the user's subscription.

getDomain Result

The following output properties are available:

Endpoint string: Endpoint for the domain.
Id string: Fully qualified identifier of the resource.
Location string: Location of the resource.
MetricResourceId string: Metric resource id for the domain.
Name string: Name of the resource.
PrivateEndpointConnections List<Pulumi.AzureNative.EventGrid.Outputs.PrivateEndpointConnectionResponse>: List of private endpoint connections.
ProvisioningState string: Provisioning state of the domain.
SystemData Pulumi.AzureNative.EventGrid.Outputs.SystemDataResponse: The system metadata relating to Domain resource.
Type string: Type of the resource.
InboundIpRules List<Pulumi.AzureNative.EventGrid.Outputs.InboundIpRuleResponse>: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
InputSchema string: This determines the format that Event Grid should expect for incoming events published to the domain.
InputSchemaMapping Pulumi.AzureNative.EventGrid.Outputs.JsonInputSchemaMappingResponse: Information about the InputSchemaMapping which specified the info about mapping event payload.
PublicNetworkAccess string: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring
Tags Dictionary<string, string>: Tags of the resource.

Endpoint string: Endpoint for the domain.
Id string: Fully qualified identifier of the resource.
Location string: Location of the resource.
MetricResourceId string: Metric resource id for the domain.
Name string: Name of the resource.
PrivateEndpointConnections []PrivateEndpointConnectionResponse: List of private endpoint connections.
ProvisioningState string: Provisioning state of the domain.
SystemData SystemDataResponse: The system metadata relating to Domain resource.
Type string: Type of the resource.
InboundIpRules []InboundIpRuleResponse: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
InputSchema string: This determines the format that Event Grid should expect for incoming events published to the domain.
InputSchemaMapping JsonInputSchemaMappingResponse: Information about the InputSchemaMapping which specified the info about mapping event payload.
PublicNetworkAccess string: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring
Tags map[string]string: Tags of the resource.

endpoint String: Endpoint for the domain.
id String: Fully qualified identifier of the resource.
location String: Location of the resource.
metricResourceId String: Metric resource id for the domain.
name String: Name of the resource.
privateEndpointConnections List<PrivateEndpointConnectionResponse>: List of private endpoint connections.
provisioningState String: Provisioning state of the domain.
systemData SystemDataResponse: The system metadata relating to Domain resource.
type String: Type of the resource.
inboundIpRules List<InboundIpRuleResponse>: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
inputSchema String: This determines the format that Event Grid should expect for incoming events published to the domain.
inputSchemaMapping JsonInputSchemaMappingResponse: Information about the InputSchemaMapping which specified the info about mapping event payload.
publicNetworkAccess String: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring
tags Map<String,String>: Tags of the resource.

endpoint string: Endpoint for the domain.
id string: Fully qualified identifier of the resource.
location string: Location of the resource.
metricResourceId string: Metric resource id for the domain.
name string: Name of the resource.
privateEndpointConnections PrivateEndpointConnectionResponse[]: List of private endpoint connections.
provisioningState string: Provisioning state of the domain.
systemData SystemDataResponse: The system metadata relating to Domain resource.
type string: Type of the resource.
inboundIpRules InboundIpRuleResponse[]: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
inputSchema string: This determines the format that Event Grid should expect for incoming events published to the domain.
inputSchemaMapping JsonInputSchemaMappingResponse: Information about the InputSchemaMapping which specified the info about mapping event payload.
publicNetworkAccess string: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring
tags {[key: string]: string}: Tags of the resource.

endpoint str: Endpoint for the domain.
id str: Fully qualified identifier of the resource.
location str: Location of the resource.
metric_resource_id str: Metric resource id for the domain.
name str: Name of the resource.
private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]: List of private endpoint connections.
provisioning_state str: Provisioning state of the domain.
system_data SystemDataResponse: The system metadata relating to Domain resource.
type str: Type of the resource.
inbound_ip_rules Sequence[InboundIpRuleResponse]: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
input_schema str: This determines the format that Event Grid should expect for incoming events published to the domain.
input_schema_mapping JsonInputSchemaMappingResponse: Information about the InputSchemaMapping which specified the info about mapping event payload.
public_network_access str: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring
tags Mapping[str, str]: Tags of the resource.

endpoint String: Endpoint for the domain.
id String: Fully qualified identifier of the resource.
location String: Location of the resource.
metricResourceId String: Metric resource id for the domain.
name String: Name of the resource.
privateEndpointConnections List<Property Map>: List of private endpoint connections.
provisioningState String: Provisioning state of the domain.
systemData Property Map: The system metadata relating to Domain resource.
type String: Type of the resource.
inboundIpRules List<Property Map>: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
inputSchema String: This determines the format that Event Grid should expect for incoming events published to the domain.
inputSchemaMapping Property Map: Information about the InputSchemaMapping which specified the info about mapping event payload.
publicNetworkAccess String: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring
tags Map<String>: Tags of the resource.

Supporting Types

ConnectionStateResponse

ActionsRequired string: Actions required (if any).
Description string: Description of the connection state.
Status string: Status of the connection.

ActionsRequired string: Actions required (if any).
Description string: Description of the connection state.
Status string: Status of the connection.

actionsRequired String: Actions required (if any).
description String: Description of the connection state.
status String: Status of the connection.

actionsRequired string: Actions required (if any).
description string: Description of the connection state.
status string: Status of the connection.

actions_required str: Actions required (if any).
description str: Description of the connection state.
status str: Status of the connection.

actionsRequired String: Actions required (if any).
description String: Description of the connection state.
status String: Status of the connection.

InboundIpRuleResponse

Action string: Action to perform based on the match or no match of the IpMask.
IpMask string: IP Address in CIDR notation e.g., 10.0.0.0/8.

Action string: Action to perform based on the match or no match of the IpMask.
IpMask string: IP Address in CIDR notation e.g., 10.0.0.0/8.

action String: Action to perform based on the match or no match of the IpMask.
ipMask String: IP Address in CIDR notation e.g., 10.0.0.0/8.

action string: Action to perform based on the match or no match of the IpMask.
ipMask string: IP Address in CIDR notation e.g., 10.0.0.0/8.

action str: Action to perform based on the match or no match of the IpMask.
ip_mask str: IP Address in CIDR notation e.g., 10.0.0.0/8.

action String: Action to perform based on the match or no match of the IpMask.
ipMask String: IP Address in CIDR notation e.g., 10.0.0.0/8.

JsonFieldResponse

SourceField string: Name of a field in the input event schema that's to be used as the source of a mapping.

SourceField string: Name of a field in the input event schema that's to be used as the source of a mapping.

sourceField String: Name of a field in the input event schema that's to be used as the source of a mapping.

sourceField string: Name of a field in the input event schema that's to be used as the source of a mapping.

source_field str: Name of a field in the input event schema that's to be used as the source of a mapping.

sourceField String: Name of a field in the input event schema that's to be used as the source of a mapping.

JsonFieldWithDefaultResponse

DefaultValue string: The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
SourceField string: Name of a field in the input event schema that's to be used as the source of a mapping.

DefaultValue string: The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
SourceField string: Name of a field in the input event schema that's to be used as the source of a mapping.

defaultValue String: The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
sourceField String: Name of a field in the input event schema that's to be used as the source of a mapping.

defaultValue string: The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
sourceField string: Name of a field in the input event schema that's to be used as the source of a mapping.

default_value str: The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
source_field str: Name of a field in the input event schema that's to be used as the source of a mapping.

defaultValue String: The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
sourceField String: Name of a field in the input event schema that's to be used as the source of a mapping.

JsonInputSchemaMappingResponse

DataVersion Pulumi.AzureNative.EventGrid.Inputs.JsonFieldWithDefaultResponse: The mapping information for the DataVersion property of the Event Grid Event.
EventTime Pulumi.AzureNative.EventGrid.Inputs.JsonFieldResponse: The mapping information for the EventTime property of the Event Grid Event.
EventType Pulumi.AzureNative.EventGrid.Inputs.JsonFieldWithDefaultResponse: The mapping information for the EventType property of the Event Grid Event.
Id Pulumi.AzureNative.EventGrid.Inputs.JsonFieldResponse: The mapping information for the Id property of the Event Grid Event.
Subject Pulumi.AzureNative.EventGrid.Inputs.JsonFieldWithDefaultResponse: The mapping information for the Subject property of the Event Grid Event.
Topic Pulumi.AzureNative.EventGrid.Inputs.JsonFieldResponse: The mapping information for the Topic property of the Event Grid Event.

DataVersion JsonFieldWithDefaultResponse: The mapping information for the DataVersion property of the Event Grid Event.
EventTime JsonFieldResponse: The mapping information for the EventTime property of the Event Grid Event.
EventType JsonFieldWithDefaultResponse: The mapping information for the EventType property of the Event Grid Event.
Id JsonFieldResponse: The mapping information for the Id property of the Event Grid Event.
Subject JsonFieldWithDefaultResponse: The mapping information for the Subject property of the Event Grid Event.
Topic JsonFieldResponse: The mapping information for the Topic property of the Event Grid Event.

dataVersion JsonFieldWithDefaultResponse: The mapping information for the DataVersion property of the Event Grid Event.
eventTime JsonFieldResponse: The mapping information for the EventTime property of the Event Grid Event.
eventType JsonFieldWithDefaultResponse: The mapping information for the EventType property of the Event Grid Event.
id JsonFieldResponse: The mapping information for the Id property of the Event Grid Event.
subject JsonFieldWithDefaultResponse: The mapping information for the Subject property of the Event Grid Event.
topic JsonFieldResponse: The mapping information for the Topic property of the Event Grid Event.

dataVersion JsonFieldWithDefaultResponse: The mapping information for the DataVersion property of the Event Grid Event.
eventTime JsonFieldResponse: The mapping information for the EventTime property of the Event Grid Event.
eventType JsonFieldWithDefaultResponse: The mapping information for the EventType property of the Event Grid Event.
id JsonFieldResponse: The mapping information for the Id property of the Event Grid Event.
subject JsonFieldWithDefaultResponse: The mapping information for the Subject property of the Event Grid Event.
topic JsonFieldResponse: The mapping information for the Topic property of the Event Grid Event.

data_version JsonFieldWithDefaultResponse: The mapping information for the DataVersion property of the Event Grid Event.
event_time JsonFieldResponse: The mapping information for the EventTime property of the Event Grid Event.
event_type JsonFieldWithDefaultResponse: The mapping information for the EventType property of the Event Grid Event.
id JsonFieldResponse: The mapping information for the Id property of the Event Grid Event.
subject JsonFieldWithDefaultResponse: The mapping information for the Subject property of the Event Grid Event.
topic JsonFieldResponse: The mapping information for the Topic property of the Event Grid Event.

dataVersion Property Map: The mapping information for the DataVersion property of the Event Grid Event.
eventTime Property Map: The mapping information for the EventTime property of the Event Grid Event.
eventType Property Map: The mapping information for the EventType property of the Event Grid Event.
id Property Map: The mapping information for the Id property of the Event Grid Event.
subject Property Map: The mapping information for the Subject property of the Event Grid Event.
topic Property Map: The mapping information for the Topic property of the Event Grid Event.

PrivateEndpointConnectionResponse

Id string: Fully qualified identifier of the resource.
Name string: Name of the resource.
Type string: Type of the resource.
GroupIds List<string>: GroupIds from the private link service resource.
PrivateEndpoint Pulumi.AzureNative.EventGrid.Inputs.PrivateEndpointResponse: The Private Endpoint resource for this Connection.
PrivateLinkServiceConnectionState Pulumi.AzureNative.EventGrid.Inputs.ConnectionStateResponse: Details about the state of the connection.
ProvisioningState string: Provisioning state of the Private Endpoint Connection.

Id string: Fully qualified identifier of the resource.
Name string: Name of the resource.
Type string: Type of the resource.
GroupIds []string: GroupIds from the private link service resource.
PrivateEndpoint PrivateEndpointResponse: The Private Endpoint resource for this Connection.
PrivateLinkServiceConnectionState ConnectionStateResponse: Details about the state of the connection.
ProvisioningState string: Provisioning state of the Private Endpoint Connection.

id String: Fully qualified identifier of the resource.
name String: Name of the resource.
type String: Type of the resource.
groupIds List<String>: GroupIds from the private link service resource.
privateEndpoint PrivateEndpointResponse: The Private Endpoint resource for this Connection.
privateLinkServiceConnectionState ConnectionStateResponse: Details about the state of the connection.
provisioningState String: Provisioning state of the Private Endpoint Connection.

id string: Fully qualified identifier of the resource.
name string: Name of the resource.
type string: Type of the resource.
groupIds string[]: GroupIds from the private link service resource.
privateEndpoint PrivateEndpointResponse: The Private Endpoint resource for this Connection.
privateLinkServiceConnectionState ConnectionStateResponse: Details about the state of the connection.
provisioningState string: Provisioning state of the Private Endpoint Connection.

id str: Fully qualified identifier of the resource.
name str: Name of the resource.
type str: Type of the resource.
group_ids Sequence[str]: GroupIds from the private link service resource.
private_endpoint PrivateEndpointResponse: The Private Endpoint resource for this Connection.
private_link_service_connection_state ConnectionStateResponse: Details about the state of the connection.
provisioning_state str: Provisioning state of the Private Endpoint Connection.

id String: Fully qualified identifier of the resource.
name String: Name of the resource.
type String: Type of the resource.
groupIds List<String>: GroupIds from the private link service resource.
privateEndpoint Property Map: The Private Endpoint resource for this Connection.
privateLinkServiceConnectionState Property Map: Details about the state of the connection.
provisioningState String: Provisioning state of the Private Endpoint Connection.

PrivateEndpointResponse

Id string: The ARM identifier for Private Endpoint.

Id string: The ARM identifier for Private Endpoint.

id String: The ARM identifier for Private Endpoint.

id string: The ARM identifier for Private Endpoint.

id str: The ARM identifier for Private Endpoint.

id String: The ARM identifier for Private Endpoint.

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.eventgrid.getDomain

On this page

On this page

Using getDomain

getDomain Result

Supporting Types

ConnectionStateResponse

InboundIpRuleResponse

JsonFieldResponse

JsonFieldWithDefaultResponse

JsonInputSchemaMappingResponse

PrivateEndpointConnectionResponse

PrivateEndpointResponse

SystemDataResponse

Package Details

On this page

On this page