Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. relay
  5. getWCFRelay
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.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.relay.getWCFRelay

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.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-azure-native

    Returns the description for the specified WCF relay. Azure REST API version: 2021-11-01.

    Other available API versions: 2016-07-01, 2024-01-01.

    Using getWCFRelay

    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 getWCFRelay(args: GetWCFRelayArgs, opts?: InvokeOptions): Promise<GetWCFRelayResult>
function getWCFRelayOutput(args: GetWCFRelayOutputArgs, opts?: InvokeOptions): Output<GetWCFRelayResult>
    def get_wcf_relay(namespace_name: Optional[str] = None,
                  relay_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetWCFRelayResult
def get_wcf_relay_output(namespace_name: Optional[pulumi.Input[str]] = None,
                  relay_name: Optional[pulumi.Input[str]] = None,
                  resource_group_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetWCFRelayResult]
    func LookupWCFRelay(ctx *Context, args *LookupWCFRelayArgs, opts ...InvokeOption) (*LookupWCFRelayResult, error)
func LookupWCFRelayOutput(ctx *Context, args *LookupWCFRelayOutputArgs, opts ...InvokeOption) LookupWCFRelayResultOutput

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

    public static class GetWCFRelay 
{
    public static Task<GetWCFRelayResult> InvokeAsync(GetWCFRelayArgs args, InvokeOptions? opts = null)
    public static Output<GetWCFRelayResult> Invoke(GetWCFRelayInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWCFRelayResult> getWCFRelay(GetWCFRelayArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:relay:getWCFRelay
  arguments:
    # arguments dictionary

    The following arguments are supported:

    NamespaceName string
    The namespace name
    RelayName string
    The relay name.
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    NamespaceName string
    The namespace name
    RelayName string
    The relay name.
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    namespaceName String
    The namespace name
    relayName String
    The relay name.
    resourceGroupName String
    Name of the Resource group within the Azure subscription.
    namespaceName string
    The namespace name
    relayName string
    The relay name.
    resourceGroupName string
    Name of the Resource group within the Azure subscription.
    namespace_name str
    The namespace name
    relay_name str
    The relay name.
    resource_group_name str
    Name of the Resource group within the Azure subscription.
    namespaceName String
    The namespace name
    relayName String
    The relay name.
    resourceGroupName String
    Name of the Resource group within the Azure subscription.

    getWCFRelay Result

    The following output properties are available:

    CreatedAt string
    The time the WCF relay was created.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    IsDynamic bool
    Returns true if the relay is dynamic; otherwise, false.
    ListenerCount int
    The number of listeners for this relay. Note that min :1 and max:25 are supported.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.Relay.Outputs.SystemDataResponse
    The system meta data relating to this resource.
    Type string
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    UpdatedAt string
    The time the namespace was updated.
    RelayType string
    WCF relay type.
    RequiresClientAuthorization bool
    Returns true if client authorization is needed for this relay; otherwise, false.
    RequiresTransportSecurity bool
    Returns true if transport security is needed for this relay; otherwise, false.
    UserMetadata string
    The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.
    CreatedAt string
    The time the WCF relay was created.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    IsDynamic bool
    Returns true if the relay is dynamic; otherwise, false.
    ListenerCount int
    The number of listeners for this relay. Note that min :1 and max:25 are supported.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    SystemData SystemDataResponse
    The system meta data relating to this resource.
    Type string
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    UpdatedAt string
    The time the namespace was updated.
    RelayType string
    WCF relay type.
    RequiresClientAuthorization bool
    Returns true if client authorization is needed for this relay; otherwise, false.
    RequiresTransportSecurity bool
    Returns true if transport security is needed for this relay; otherwise, false.
    UserMetadata string
    The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.
    createdAt String
    The time the WCF relay was created.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    isDynamic Boolean
    Returns true if the relay is dynamic; otherwise, false.
    listenerCount Integer
    The number of listeners for this relay. Note that min :1 and max:25 are supported.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    systemData SystemDataResponse
    The system meta data relating to this resource.
    type String
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    updatedAt String
    The time the namespace was updated.
    relayType String
    WCF relay type.
    requiresClientAuthorization Boolean
    Returns true if client authorization is needed for this relay; otherwise, false.
    requiresTransportSecurity Boolean
    Returns true if transport security is needed for this relay; otherwise, false.
    userMetadata String
    The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.
    createdAt string
    The time the WCF relay was created.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    isDynamic boolean
    Returns true if the relay is dynamic; otherwise, false.
    listenerCount number
    The number of listeners for this relay. Note that min :1 and max:25 are supported.
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    systemData SystemDataResponse
    The system meta data relating to this resource.
    type string
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    updatedAt string
    The time the namespace was updated.
    relayType string
    WCF relay type.
    requiresClientAuthorization boolean
    Returns true if client authorization is needed for this relay; otherwise, false.
    requiresTransportSecurity boolean
    Returns true if transport security is needed for this relay; otherwise, false.
    userMetadata string
    The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.
    created_at str
    The time the WCF relay was created.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    is_dynamic bool
    Returns true if the relay is dynamic; otherwise, false.
    listener_count int
    The number of listeners for this relay. Note that min :1 and max:25 are supported.
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    system_data SystemDataResponse
    The system meta data relating to this resource.
    type str
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    updated_at str
    The time the namespace was updated.
    relay_type str
    WCF relay type.
    requires_client_authorization bool
    Returns true if client authorization is needed for this relay; otherwise, false.
    requires_transport_security bool
    Returns true if transport security is needed for this relay; otherwise, false.
    user_metadata str
    The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.
    createdAt String
    The time the WCF relay was created.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    isDynamic Boolean
    Returns true if the relay is dynamic; otherwise, false.
    listenerCount Number
    The number of listeners for this relay. Note that min :1 and max:25 are supported.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    systemData Property Map
    The system meta data relating to this resource.
    type String
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    updatedAt String
    The time the namespace was updated.
    relayType String
    WCF relay type.
    requiresClientAuthorization Boolean
    Returns true if client authorization is needed for this relay; otherwise, false.
    requiresTransportSecurity Boolean
    Returns true if transport security is needed for this relay; otherwise, false.
    userMetadata String
    The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.

    Supporting Types

    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.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
    pulumi/pulumi-azure-native