1. Packages
  2. Azure Native
  3. API Docs
  4. eventgrid
  5. getPartnerNamespace
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi

azure-native.eventgrid.getPartnerNamespace

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi

    Get properties of a partner namespace. Azure REST API version: 2022-06-15.

    Other available API versions: 2023-06-01-preview, 2023-12-15-preview.

    Using getPartnerNamespace

    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 getPartnerNamespace(args: GetPartnerNamespaceArgs, opts?: InvokeOptions): Promise<GetPartnerNamespaceResult>
    function getPartnerNamespaceOutput(args: GetPartnerNamespaceOutputArgs, opts?: InvokeOptions): Output<GetPartnerNamespaceResult>
    def get_partner_namespace(partner_namespace_name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetPartnerNamespaceResult
    def get_partner_namespace_output(partner_namespace_name: Optional[pulumi.Input[str]] = None,
                              resource_group_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetPartnerNamespaceResult]
    func LookupPartnerNamespace(ctx *Context, args *LookupPartnerNamespaceArgs, opts ...InvokeOption) (*LookupPartnerNamespaceResult, error)
    func LookupPartnerNamespaceOutput(ctx *Context, args *LookupPartnerNamespaceOutputArgs, opts ...InvokeOption) LookupPartnerNamespaceResultOutput

    > Note: This function is named LookupPartnerNamespace in the Go SDK.

    public static class GetPartnerNamespace 
    {
        public static Task<GetPartnerNamespaceResult> InvokeAsync(GetPartnerNamespaceArgs args, InvokeOptions? opts = null)
        public static Output<GetPartnerNamespaceResult> Invoke(GetPartnerNamespaceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPartnerNamespaceResult> getPartnerNamespace(GetPartnerNamespaceArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:eventgrid:getPartnerNamespace
      arguments:
        # arguments dictionary

    The following arguments are supported:

    PartnerNamespaceName string
    Name of the partner namespace.
    ResourceGroupName string
    The name of the resource group within the user's subscription.
    PartnerNamespaceName string
    Name of the partner namespace.
    ResourceGroupName string
    The name of the resource group within the user's subscription.
    partnerNamespaceName String
    Name of the partner namespace.
    resourceGroupName String
    The name of the resource group within the user's subscription.
    partnerNamespaceName string
    Name of the partner namespace.
    resourceGroupName string
    The name of the resource group within the user's subscription.
    partner_namespace_name str
    Name of the partner namespace.
    resource_group_name str
    The name of the resource group within the user's subscription.
    partnerNamespaceName String
    Name of the partner namespace.
    resourceGroupName String
    The name of the resource group within the user's subscription.

    getPartnerNamespace Result

    The following output properties are available:

    Endpoint string
    Endpoint for the partner namespace.
    Id string
    Fully qualified identifier of the resource.
    Location string
    Location of the resource.
    Name string
    Name of the resource.
    PrivateEndpointConnections List<Pulumi.AzureNative.EventGrid.Outputs.PrivateEndpointConnectionResponse>
    ProvisioningState string
    Provisioning state of the partner namespace.
    SystemData Pulumi.AzureNative.EventGrid.Outputs.SystemDataResponse
    The system metadata relating to Partner Namespace resource.
    Type string
    Type of the resource.
    DisableLocalAuth bool
    This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace.
    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.
    PartnerRegistrationFullyQualifiedId string
    The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
    PartnerTopicRoutingMode string
    This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic.
    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 partner namespace.
    Id string
    Fully qualified identifier of the resource.
    Location string
    Location of the resource.
    Name string
    Name of the resource.
    PrivateEndpointConnections []PrivateEndpointConnectionResponse
    ProvisioningState string
    Provisioning state of the partner namespace.
    SystemData SystemDataResponse
    The system metadata relating to Partner Namespace resource.
    Type string
    Type of the resource.
    DisableLocalAuth bool
    This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace.
    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.
    PartnerRegistrationFullyQualifiedId string
    The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
    PartnerTopicRoutingMode string
    This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic.
    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 partner namespace.
    id String
    Fully qualified identifier of the resource.
    location String
    Location of the resource.
    name String
    Name of the resource.
    privateEndpointConnections List<PrivateEndpointConnectionResponse>
    provisioningState String
    Provisioning state of the partner namespace.
    systemData SystemDataResponse
    The system metadata relating to Partner Namespace resource.
    type String
    Type of the resource.
    disableLocalAuth Boolean
    This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace.
    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.
    partnerRegistrationFullyQualifiedId String
    The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
    partnerTopicRoutingMode String
    This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic.
    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 partner namespace.
    id string
    Fully qualified identifier of the resource.
    location string
    Location of the resource.
    name string
    Name of the resource.
    privateEndpointConnections PrivateEndpointConnectionResponse[]
    provisioningState string
    Provisioning state of the partner namespace.
    systemData SystemDataResponse
    The system metadata relating to Partner Namespace resource.
    type string
    Type of the resource.
    disableLocalAuth boolean
    This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace.
    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.
    partnerRegistrationFullyQualifiedId string
    The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
    partnerTopicRoutingMode string
    This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic.
    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 partner namespace.
    id str
    Fully qualified identifier of the resource.
    location str
    Location of the resource.
    name str
    Name of the resource.
    private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
    provisioning_state str
    Provisioning state of the partner namespace.
    system_data SystemDataResponse
    The system metadata relating to Partner Namespace resource.
    type str
    Type of the resource.
    disable_local_auth bool
    This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace.
    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.
    partner_registration_fully_qualified_id str
    The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
    partner_topic_routing_mode str
    This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic.
    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 partner namespace.
    id String
    Fully qualified identifier of the resource.
    location String
    Location of the resource.
    name String
    Name of the resource.
    privateEndpointConnections List<Property Map>
    provisioningState String
    Provisioning state of the partner namespace.
    systemData Property Map
    The system metadata relating to Partner Namespace resource.
    type String
    Type of the resource.
    disableLocalAuth Boolean
    This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the partner namespace.
    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.
    partnerRegistrationFullyQualifiedId String
    The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
    partnerTopicRoutingMode String
    This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic.
    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.

    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 logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi