Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. eventgrid
  5. getTopic
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.eventgrid.getTopic

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    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:

    ResourceGroupName string
    The name of the resource group within the user's subscription.
    TopicName string
    Name of the topic.
    ResourceGroupName string
    The name of the resource group within the user's subscription.
    TopicName string
    Name of the topic.
    resourceGroupName String
    The name of the resource group within the user's subscription.
    topicName String
    Name of the topic.
    resourceGroupName string
    The name of the resource group within the user's subscription.
    topicName string
    Name of the topic.
    resource_group_name str
    The name of the resource group within the user's subscription.
    topic_name str
    Name of the topic.
    resourceGroupName String
    The name of the resource group within the user's subscription.
    topicName 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.
    MetricResourceId string
    Metric resource id for the topic.
    Name string
    Name of the resource.
    PrivateEndpointConnections List<Pulumi.AzureNative.EventGrid.Outputs.PrivateEndpointConnectionResponse>
    ProvisioningState string
    Provisioning state of the topic.
    SystemData Pulumi.AzureNative.EventGrid.Outputs.SystemDataResponse
    The system metadata relating to Topic 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 topic.
    InputSchemaMapping Pulumi.AzureNative.EventGrid.Outputs.JsonInputSchemaMappingResponse
    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.
    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 topic.
    Id string
    Fully qualified identifier of the resource.
    Location string
    Location of the resource.
    MetricResourceId string
    Metric resource id for the topic.
    Name string
    Name of the resource.
    PrivateEndpointConnections []PrivateEndpointConnectionResponse
    ProvisioningState string
    Provisioning state of the topic.
    SystemData SystemDataResponse
    The system metadata relating to Topic 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 topic.
    InputSchemaMapping JsonInputSchemaMappingResponse
    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.
    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 topic.
    id String
    Fully qualified identifier of the resource.
    location String
    Location of the resource.
    metricResourceId String
    Metric resource id for the topic.
    name String
    Name of the resource.
    privateEndpointConnections List<PrivateEndpointConnectionResponse>
    provisioningState String
    Provisioning state of the topic.
    systemData SystemDataResponse
    The system metadata relating to Topic 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 topic.
    inputSchemaMapping JsonInputSchemaMappingResponse
    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.
    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 topic.
    id string
    Fully qualified identifier of the resource.
    location string
    Location of the resource.
    metricResourceId string
    Metric resource id for the topic.
    name string
    Name of the resource.
    privateEndpointConnections PrivateEndpointConnectionResponse[]
    provisioningState string
    Provisioning state of the topic.
    systemData SystemDataResponse
    The system metadata relating to Topic 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 topic.
    inputSchemaMapping JsonInputSchemaMappingResponse
    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.
    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 topic.
    id str
    Fully qualified identifier of the resource.
    location str
    Location of the resource.
    metric_resource_id str
    Metric resource id for the topic.
    name str
    Name of the resource.
    private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
    provisioning_state str
    Provisioning state of the topic.
    system_data SystemDataResponse
    The system metadata relating to Topic 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 topic.
    input_schema_mapping JsonInputSchemaMappingResponse
    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_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 topic.
    id String
    Fully qualified identifier of the resource.
    location String
    Location of the resource.
    metricResourceId String
    Metric resource id for the topic.
    name String
    Name of the resource.
    privateEndpointConnections List<Property Map>
    provisioningState String
    Provisioning state of the topic.
    systemData Property Map
    The system metadata relating to Topic 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 topic.
    inputSchemaMapping Property Map
    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.
    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-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native