Azure Native v1.102.0, May 2 23
Azure Native v1.102.0, May 2 23
azure-native.eventgrid.getTopic
Explore with Pulumi AI
Get properties of a topic. API Version: 2020-06-01.
Using getTopic
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 getTopic(args: GetTopicArgs, opts?: InvokeOptions): Promise<GetTopicResult>
function getTopicOutput(args: GetTopicOutputArgs, opts?: InvokeOptions): Output<GetTopicResult>
def get_topic(resource_group_name: Optional[str] = None,
topic_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetTopicResult
def get_topic_output(resource_group_name: Optional[pulumi.Input[str]] = None,
topic_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetTopicResult]
func LookupTopic(ctx *Context, args *LookupTopicArgs, opts ...InvokeOption) (*LookupTopicResult, error)
func LookupTopicOutput(ctx *Context, args *LookupTopicOutputArgs, opts ...InvokeOption) LookupTopicResultOutput
> Note: This function is named LookupTopic
in the Go SDK.
public static class GetTopic
{
public static Task<GetTopicResult> InvokeAsync(GetTopicArgs args, InvokeOptions? opts = null)
public static Output<GetTopicResult> Invoke(GetTopicInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetTopicResult> getTopic(GetTopicArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:eventgrid:getTopic
arguments:
# arguments dictionary
The following arguments are supported:
- Resource
Group stringName The name of the resource group within the user's subscription.
- Topic
Name string Name of the topic.
- Resource
Group stringName The name of the resource group within the user's subscription.
- Topic
Name string Name of the topic.
- resource
Group StringName The name of the resource group within the user's subscription.
- topic
Name String Name of the topic.
- resource
Group stringName The name of the resource group within the user's subscription.
- topic
Name string Name of the topic.
- resource_
group_ strname The name of the resource group within the user's subscription.
- topic_
name str Name of the topic.
- resource
Group StringName The name of the resource group within the user's subscription.
- topic
Name String Name of the topic.
getTopic Result
The following output properties are available:
- Endpoint string
Endpoint for the topic.
- Id string
Fully qualified identifier of the resource.
- Location string
Location of the resource.
- Metric
Resource stringId Metric resource id for the topic.
- Name string
Name of the resource.
- Private
Endpoint List<Pulumi.Connections Azure Native. Event Grid. Outputs. Private Endpoint Connection Response> - Provisioning
State string Provisioning state of the topic.
- System
Data Pulumi.Azure Native. Event Grid. Outputs. System Data Response The system metadata relating to Topic resource.
- Type string
Type of the resource.
- Inbound
Ip List<Pulumi.Rules Azure Native. Event Grid. Outputs. Inbound Ip Rule Response> 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 string This determines the format that Event Grid should expect for incoming events published to the topic.
- Input
Schema Pulumi.Mapping Azure Native. Event Grid. Outputs. Json Input Schema Mapping Response This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema.
- Public
Network stringAccess This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring
- Dictionary<string, string>
Tags of the resource.
- Endpoint string
Endpoint for the topic.
- Id string
Fully qualified identifier of the resource.
- Location string
Location of the resource.
- Metric
Resource stringId Metric resource id for the topic.
- Name string
Name of the resource.
- Private
Endpoint []PrivateConnections Endpoint Connection Response - Provisioning
State string Provisioning state of the topic.
- System
Data SystemData Response The system metadata relating to Topic resource.
- Type string
Type of the resource.
- Inbound
Ip []InboundRules Ip Rule Response 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 string This determines the format that Event Grid should expect for incoming events published to the topic.
- Input
Schema JsonMapping Input Schema Mapping Response This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema.
- Public
Network stringAccess This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring
- map[string]string
Tags of the resource.
- endpoint String
Endpoint for the topic.
- id String
Fully qualified identifier of the resource.
- location String
Location of the resource.
- metric
Resource StringId Metric resource id for the topic.
- name String
Name of the resource.
- private
Endpoint List<PrivateConnections Endpoint Connection Response> - provisioning
State String Provisioning state of the topic.
- system
Data SystemData Response The system metadata relating to Topic resource.
- type String
Type of the resource.
- inbound
Ip List<InboundRules Ip Rule Response> 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 String This determines the format that Event Grid should expect for incoming events published to the topic.
- input
Schema JsonMapping Input Schema Mapping Response This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema.
- public
Network StringAccess This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring
- Map<String,String>
Tags of the resource.
- endpoint string
Endpoint for the topic.
- id string
Fully qualified identifier of the resource.
- location string
Location of the resource.
- metric
Resource stringId Metric resource id for the topic.
- name string
Name of the resource.
- private
Endpoint PrivateConnections Endpoint Connection Response[] - provisioning
State string Provisioning state of the topic.
- system
Data SystemData Response The system metadata relating to Topic resource.
- type string
Type of the resource.
- inbound
Ip InboundRules Ip Rule Response[] 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 string This determines the format that Event Grid should expect for incoming events published to the topic.
- input
Schema JsonMapping Input Schema Mapping Response This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema.
- public
Network stringAccess This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring
- {[key: string]: string}
Tags of the resource.
- endpoint str
Endpoint for the topic.
- id str
Fully qualified identifier of the resource.
- location str
Location of the resource.
- metric_
resource_ strid Metric resource id for the topic.
- name str
Name of the resource.
- private_
endpoint_ Sequence[Privateconnections Endpoint Connection Response] - provisioning_
state str Provisioning state of the topic.
- system_
data SystemData Response The system metadata relating to Topic resource.
- type str
Type of the resource.
- inbound_
ip_ Sequence[Inboundrules Ip Rule Response] 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 topic.
- input_
schema_ Jsonmapping Input Schema Mapping Response This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema.
- public_
network_ straccess This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring
- Mapping[str, str]
Tags of the resource.
- endpoint String
Endpoint for the topic.
- id String
Fully qualified identifier of the resource.
- location String
Location of the resource.
- metric
Resource StringId Metric resource id for the topic.
- name String
Name of the resource.
- private
Endpoint List<Property Map>Connections - provisioning
State String Provisioning state of the topic.
- system
Data Property Map The system metadata relating to Topic resource.
- type String
Type of the resource.
- inbound
Ip List<Property Map>Rules 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 String This determines the format that Event Grid should expect for incoming events published to the topic.
- input
Schema Property MapMapping This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema.
- public
Network StringAccess This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring
- Map<String>
Tags of the resource.
Supporting Types
ConnectionStateResponse
- Actions
Required string Actions required (if any).
- Description string
Description of the connection state.
- Status string
Status of the connection.
- Actions
Required string Actions required (if any).
- Description string
Description of the connection state.
- Status string
Status of the connection.
- actions
Required String Actions required (if any).
- description String
Description of the connection state.
- status String
Status of the connection.
- actions
Required 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.
- actions
Required String Actions required (if any).
- description String
Description of the connection state.
- status String
Status of the connection.
InboundIpRuleResponse
JsonFieldResponse
- Source
Field string Name of a field in the input event schema that's to be used as the source of a mapping.
- Source
Field string Name of a field in the input event schema that's to be used as the source of a mapping.
- source
Field String Name of a field in the input event schema that's to be used as the source of a mapping.
- source
Field 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.
- source
Field String Name of a field in the input event schema that's to be used as the source of a mapping.
JsonFieldWithDefaultResponse
- Default
Value 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.
- Source
Field string Name of a field in the input event schema that's to be used as the source of a mapping.
- Default
Value 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.
- Source
Field string Name of a field in the input event schema that's to be used as the source of a mapping.
- default
Value 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.
- source
Field String Name of a field in the input event schema that's to be used as the source of a mapping.
- default
Value 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.
- source
Field 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.
- default
Value 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.
- source
Field String Name of a field in the input event schema that's to be used as the source of a mapping.
JsonInputSchemaMappingResponse
- Data
Version Pulumi.Azure Native. Event Grid. Inputs. Json Field With Default Response The mapping information for the DataVersion property of the Event Grid Event.
- Event
Time Pulumi.Azure Native. Event Grid. Inputs. Json Field Response The mapping information for the EventTime property of the Event Grid Event.
- Event
Type Pulumi.Azure Native. Event Grid. Inputs. Json Field With Default Response The mapping information for the EventType property of the Event Grid Event.
- Id
Pulumi.
Azure Native. Event Grid. Inputs. Json Field Response The mapping information for the Id property of the Event Grid Event.
- Subject
Pulumi.
Azure Native. Event Grid. Inputs. Json Field With Default Response The mapping information for the Subject property of the Event Grid Event.
- Topic
Pulumi.
Azure Native. Event Grid. Inputs. Json Field Response The mapping information for the Topic property of the Event Grid Event.
- Data
Version JsonField With Default Response The mapping information for the DataVersion property of the Event Grid Event.
- Event
Time JsonField Response The mapping information for the EventTime property of the Event Grid Event.
- Event
Type JsonField With Default Response The mapping information for the EventType property of the Event Grid Event.
- Id
Json
Field Response The mapping information for the Id property of the Event Grid Event.
- Subject
Json
Field With Default Response The mapping information for the Subject property of the Event Grid Event.
- Topic
Json
Field Response The mapping information for the Topic property of the Event Grid Event.
- data
Version JsonField With Default Response The mapping information for the DataVersion property of the Event Grid Event.
- event
Time JsonField Response The mapping information for the EventTime property of the Event Grid Event.
- event
Type JsonField With Default Response The mapping information for the EventType property of the Event Grid Event.
- id
Json
Field Response The mapping information for the Id property of the Event Grid Event.
- subject
Json
Field With Default Response The mapping information for the Subject property of the Event Grid Event.
- topic
Json
Field Response The mapping information for the Topic property of the Event Grid Event.
- data
Version JsonField With Default Response The mapping information for the DataVersion property of the Event Grid Event.
- event
Time JsonField Response The mapping information for the EventTime property of the Event Grid Event.
- event
Type JsonField With Default Response The mapping information for the EventType property of the Event Grid Event.
- id
Json
Field Response The mapping information for the Id property of the Event Grid Event.
- subject
Json
Field With Default Response The mapping information for the Subject property of the Event Grid Event.
- topic
Json
Field Response The mapping information for the Topic property of the Event Grid Event.
- data_
version JsonField With Default Response The mapping information for the DataVersion property of the Event Grid Event.
- event_
time JsonField Response The mapping information for the EventTime property of the Event Grid Event.
- event_
type JsonField With Default Response The mapping information for the EventType property of the Event Grid Event.
- id
Json
Field Response The mapping information for the Id property of the Event Grid Event.
- subject
Json
Field With Default Response The mapping information for the Subject property of the Event Grid Event.
- topic
Json
Field Response The mapping information for the Topic property of the Event Grid Event.
- data
Version Property Map The mapping information for the DataVersion property of the Event Grid Event.
- event
Time Property Map The mapping information for the EventTime property of the Event Grid Event.
- event
Type 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.
- Group
Ids List<string> GroupIds from the private link service resource.
- Private
Endpoint Pulumi.Azure Native. Event Grid. Inputs. Private Endpoint Response The Private Endpoint resource for this Connection.
- Private
Link Pulumi.Service Connection State Azure Native. Event Grid. Inputs. Connection State Response Details about the state of the connection.
- Provisioning
State 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.
- Group
Ids []string GroupIds from the private link service resource.
- Private
Endpoint PrivateEndpoint Response The Private Endpoint resource for this Connection.
- Private
Link ConnectionService Connection State State Response Details about the state of the connection.
- Provisioning
State 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.
- group
Ids List<String> GroupIds from the private link service resource.
- private
Endpoint PrivateEndpoint Response The Private Endpoint resource for this Connection.
- private
Link ConnectionService Connection State State Response Details about the state of the connection.
- provisioning
State 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.
- group
Ids string[] GroupIds from the private link service resource.
- private
Endpoint PrivateEndpoint Response The Private Endpoint resource for this Connection.
- private
Link ConnectionService Connection State State Response Details about the state of the connection.
- provisioning
State 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 PrivateEndpoint Response The Private Endpoint resource for this Connection.
- private_
link_ Connectionservice_ connection_ state State Response 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.
- group
Ids List<String> GroupIds from the private link service resource.
- private
Endpoint Property Map The Private Endpoint resource for this Connection.
- private
Link Property MapService Connection State Details about the state of the connection.
- provisioning
State 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
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
- created
At string The timestamp of resource creation (UTC).
- created
By string The identity that created the resource.
- created
By stringType The type of identity that created the resource.
- last
Modified stringAt The timestamp of resource last modification (UTC)
- last
Modified stringBy The identity that last modified the resource.
- last
Modified stringBy Type 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_ strtype The type of identity that created the resource.
- last_
modified_ strat The timestamp of resource last modification (UTC)
- last_
modified_ strby The identity that last modified the resource.
- last_
modified_ strby_ type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0