Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. iotoperations
  5. getBrokerListener
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.iotoperations.getBrokerListener

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

    Get a BrokerListenerResource Azure REST API version: 2024-07-01-preview.

    Other available API versions: 2024-08-15-preview.

    Using getBrokerListener

    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 getBrokerListener(args: GetBrokerListenerArgs, opts?: InvokeOptions): Promise<GetBrokerListenerResult>
function getBrokerListenerOutput(args: GetBrokerListenerOutputArgs, opts?: InvokeOptions): Output<GetBrokerListenerResult>
    def get_broker_listener(broker_name: Optional[str] = None,
                        instance_name: Optional[str] = None,
                        listener_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetBrokerListenerResult
def get_broker_listener_output(broker_name: Optional[pulumi.Input[str]] = None,
                        instance_name: Optional[pulumi.Input[str]] = None,
                        listener_name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetBrokerListenerResult]
    func LookupBrokerListener(ctx *Context, args *LookupBrokerListenerArgs, opts ...InvokeOption) (*LookupBrokerListenerResult, error)
func LookupBrokerListenerOutput(ctx *Context, args *LookupBrokerListenerOutputArgs, opts ...InvokeOption) LookupBrokerListenerResultOutput

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

    public static class GetBrokerListener 
{
    public static Task<GetBrokerListenerResult> InvokeAsync(GetBrokerListenerArgs args, InvokeOptions? opts = null)
    public static Output<GetBrokerListenerResult> Invoke(GetBrokerListenerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBrokerListenerResult> getBrokerListener(GetBrokerListenerArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:iotoperations:getBrokerListener
  arguments:
    # arguments dictionary

    The following arguments are supported:

    BrokerName string
    Name of broker.
    InstanceName string
    Name of instance.
    ListenerName string
    Name of Instance broker listener resource
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    BrokerName string
    Name of broker.
    InstanceName string
    Name of instance.
    ListenerName string
    Name of Instance broker listener resource
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    brokerName String
    Name of broker.
    instanceName String
    Name of instance.
    listenerName String
    Name of Instance broker listener resource
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    brokerName string
    Name of broker.
    instanceName string
    Name of instance.
    listenerName string
    Name of Instance broker listener resource
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    broker_name str
    Name of broker.
    instance_name str
    Name of instance.
    listener_name str
    Name of Instance broker listener resource
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    brokerName String
    Name of broker.
    instanceName String
    Name of instance.
    listenerName String
    Name of Instance broker listener resource
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getBrokerListener Result

    The following output properties are available:

    ExtendedLocation Pulumi.AzureNative.IoTOperations.Outputs.ExtendedLocationResponse
    Edge location of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.IoTOperations.Outputs.BrokerListenerPropertiesResponse
    The resource-specific properties for this resource.
    SystemData Pulumi.AzureNative.IoTOperations.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    ExtendedLocation ExtendedLocationResponse
    Edge location of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties BrokerListenerPropertiesResponse
    The resource-specific properties for this resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extendedLocation ExtendedLocationResponse
    Edge location of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties BrokerListenerPropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extendedLocation ExtendedLocationResponse
    Edge location of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    properties BrokerListenerPropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extended_location ExtendedLocationResponse
    Edge location of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    properties BrokerListenerPropertiesResponse
    The resource-specific properties for this resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extendedLocation Property Map
    Edge location of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties Property Map
    The resource-specific properties for this resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    AutomaticCertMethodResponse

    IssuerRef Pulumi.AzureNative.IoTOperations.Inputs.CertManagerIssuerRefResponse
    cert-manager issuerRef.
    Duration string
    Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes.
    PrivateKey Pulumi.AzureNative.IoTOperations.Inputs.CertManagerPrivateKeyResponse
    Type of certificate private key.
    RenewBefore string
    When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes.
    San Pulumi.AzureNative.IoTOperations.Inputs.SanForCertResponse
    Additional Subject Alternative Names (SANs) to include in the certificate.
    SecretRef string
    Secret for storing server certificate. Any existing data will be overwritten. This is a reference to the secret through an identifying name, not the secret itself.
    IssuerRef CertManagerIssuerRefResponse
    cert-manager issuerRef.
    Duration string
    Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes.
    PrivateKey CertManagerPrivateKeyResponse
    Type of certificate private key.
    RenewBefore string
    When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes.
    San SanForCertResponse
    Additional Subject Alternative Names (SANs) to include in the certificate.
    SecretRef string
    Secret for storing server certificate. Any existing data will be overwritten. This is a reference to the secret through an identifying name, not the secret itself.
    issuerRef CertManagerIssuerRefResponse
    cert-manager issuerRef.
    duration String
    Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes.
    privateKey CertManagerPrivateKeyResponse
    Type of certificate private key.
    renewBefore String
    When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes.
    san SanForCertResponse
    Additional Subject Alternative Names (SANs) to include in the certificate.
    secretRef String
    Secret for storing server certificate. Any existing data will be overwritten. This is a reference to the secret through an identifying name, not the secret itself.
    issuerRef CertManagerIssuerRefResponse
    cert-manager issuerRef.
    duration string
    Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes.
    privateKey CertManagerPrivateKeyResponse
    Type of certificate private key.
    renewBefore string
    When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes.
    san SanForCertResponse
    Additional Subject Alternative Names (SANs) to include in the certificate.
    secretRef string
    Secret for storing server certificate. Any existing data will be overwritten. This is a reference to the secret through an identifying name, not the secret itself.
    issuer_ref CertManagerIssuerRefResponse
    cert-manager issuerRef.
    duration str
    Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes.
    private_key CertManagerPrivateKeyResponse
    Type of certificate private key.
    renew_before str
    When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes.
    san SanForCertResponse
    Additional Subject Alternative Names (SANs) to include in the certificate.
    secret_ref str
    Secret for storing server certificate. Any existing data will be overwritten. This is a reference to the secret through an identifying name, not the secret itself.
    issuerRef Property Map
    cert-manager issuerRef.
    duration String
    Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes.
    privateKey Property Map
    Type of certificate private key.
    renewBefore String
    When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes.
    san Property Map
    Additional Subject Alternative Names (SANs) to include in the certificate.
    secretRef String
    Secret for storing server certificate. Any existing data will be overwritten. This is a reference to the secret through an identifying name, not the secret itself.

    BrokerListenerPropertiesResponse

    BrokerRef string
    Broker associated with this listener.
    Ports List<Pulumi.AzureNative.IoTOperations.Inputs.ListenerPortResponse>
    Ports on which this listener accepts client connections.
    ProvisioningState string
    The status of the last operation.
    ServiceName string
    Kubernetes Service name of this listener.
    ServiceType string
    Kubernetes Service type of this listener.
    BrokerRef string
    Broker associated with this listener.
    Ports []ListenerPortResponse
    Ports on which this listener accepts client connections.
    ProvisioningState string
    The status of the last operation.
    ServiceName string
    Kubernetes Service name of this listener.
    ServiceType string
    Kubernetes Service type of this listener.
    brokerRef String
    Broker associated with this listener.
    ports List<ListenerPortResponse>
    Ports on which this listener accepts client connections.
    provisioningState String
    The status of the last operation.
    serviceName String
    Kubernetes Service name of this listener.
    serviceType String
    Kubernetes Service type of this listener.
    brokerRef string
    Broker associated with this listener.
    ports ListenerPortResponse[]
    Ports on which this listener accepts client connections.
    provisioningState string
    The status of the last operation.
    serviceName string
    Kubernetes Service name of this listener.
    serviceType string
    Kubernetes Service type of this listener.
    broker_ref str
    Broker associated with this listener.
    ports Sequence[ListenerPortResponse]
    Ports on which this listener accepts client connections.
    provisioning_state str
    The status of the last operation.
    service_name str
    Kubernetes Service name of this listener.
    service_type str
    Kubernetes Service type of this listener.
    brokerRef String
    Broker associated with this listener.
    ports List<Property Map>
    Ports on which this listener accepts client connections.
    provisioningState String
    The status of the last operation.
    serviceName String
    Kubernetes Service name of this listener.
    serviceType String
    Kubernetes Service type of this listener.

    CertManagerIssuerRefResponse

    ApiGroup string
    group of issuer.
    Kind string
    kind of issuer (Issuer or ClusterIssuer).
    Name string
    name of issuer.
    ApiGroup string
    group of issuer.
    Kind string
    kind of issuer (Issuer or ClusterIssuer).
    Name string
    name of issuer.
    apiGroup String
    group of issuer.
    kind String
    kind of issuer (Issuer or ClusterIssuer).
    name String
    name of issuer.
    apiGroup string
    group of issuer.
    kind string
    kind of issuer (Issuer or ClusterIssuer).
    name string
    name of issuer.
    api_group str
    group of issuer.
    kind str
    kind of issuer (Issuer or ClusterIssuer).
    name str
    name of issuer.
    apiGroup String
    group of issuer.
    kind String
    kind of issuer (Issuer or ClusterIssuer).
    name String
    name of issuer.

    CertManagerPrivateKeyResponse

    Algorithm string
    algorithm for private key.
    RotationPolicy string
    cert-manager private key rotationPolicy.
    Algorithm string
    algorithm for private key.
    RotationPolicy string
    cert-manager private key rotationPolicy.
    algorithm String
    algorithm for private key.
    rotationPolicy String
    cert-manager private key rotationPolicy.
    algorithm string
    algorithm for private key.
    rotationPolicy string
    cert-manager private key rotationPolicy.
    algorithm str
    algorithm for private key.
    rotation_policy str
    cert-manager private key rotationPolicy.
    algorithm String
    algorithm for private key.
    rotationPolicy String
    cert-manager private key rotationPolicy.

    ExtendedLocationResponse

    Name string
    The name of the extended location.
    Type string
    Type of ExtendedLocation.
    Name string
    The name of the extended location.
    Type string
    Type of ExtendedLocation.
    name String
    The name of the extended location.
    type String
    Type of ExtendedLocation.
    name string
    The name of the extended location.
    type string
    Type of ExtendedLocation.
    name str
    The name of the extended location.
    type str
    Type of ExtendedLocation.
    name String
    The name of the extended location.
    type String
    Type of ExtendedLocation.

    ListenerPortResponse

    Port int
    TCP port for accepting client connections.
    AuthenticationRef string
    Reference to client authentication settings. Omit to disable authentication.
    AuthorizationRef string
    Reference to client authorization settings. Omit to disable authorization.
    NodePort int
    Kubernetes node port. Only relevant when this port is associated with a NodePort listener.
    Protocol string
    Protocol to use for client connections.
    Tls Pulumi.AzureNative.IoTOperations.Inputs.TlsCertMethodResponse
    TLS server certificate settings for this port. Omit to disable TLS.
    Port int
    TCP port for accepting client connections.
    AuthenticationRef string
    Reference to client authentication settings. Omit to disable authentication.
    AuthorizationRef string
    Reference to client authorization settings. Omit to disable authorization.
    NodePort int
    Kubernetes node port. Only relevant when this port is associated with a NodePort listener.
    Protocol string
    Protocol to use for client connections.
    Tls TlsCertMethodResponse
    TLS server certificate settings for this port. Omit to disable TLS.
    port Integer
    TCP port for accepting client connections.
    authenticationRef String
    Reference to client authentication settings. Omit to disable authentication.
    authorizationRef String
    Reference to client authorization settings. Omit to disable authorization.
    nodePort Integer
    Kubernetes node port. Only relevant when this port is associated with a NodePort listener.
    protocol String
    Protocol to use for client connections.
    tls TlsCertMethodResponse
    TLS server certificate settings for this port. Omit to disable TLS.
    port number
    TCP port for accepting client connections.
    authenticationRef string
    Reference to client authentication settings. Omit to disable authentication.
    authorizationRef string
    Reference to client authorization settings. Omit to disable authorization.
    nodePort number
    Kubernetes node port. Only relevant when this port is associated with a NodePort listener.
    protocol string
    Protocol to use for client connections.
    tls TlsCertMethodResponse
    TLS server certificate settings for this port. Omit to disable TLS.
    port int
    TCP port for accepting client connections.
    authentication_ref str
    Reference to client authentication settings. Omit to disable authentication.
    authorization_ref str
    Reference to client authorization settings. Omit to disable authorization.
    node_port int
    Kubernetes node port. Only relevant when this port is associated with a NodePort listener.
    protocol str
    Protocol to use for client connections.
    tls TlsCertMethodResponse
    TLS server certificate settings for this port. Omit to disable TLS.
    port Number
    TCP port for accepting client connections.
    authenticationRef String
    Reference to client authentication settings. Omit to disable authentication.
    authorizationRef String
    Reference to client authorization settings. Omit to disable authorization.
    nodePort Number
    Kubernetes node port. Only relevant when this port is associated with a NodePort listener.
    protocol String
    Protocol to use for client connections.
    tls Property Map
    TLS server certificate settings for this port. Omit to disable TLS.

    SanForCertResponse

    Dns List<string>
    DNS SANs.
    Ip List<string>
    IP address SANs.
    Dns []string
    DNS SANs.
    Ip []string
    IP address SANs.
    dns List<String>
    DNS SANs.
    ip List<String>
    IP address SANs.
    dns string[]
    DNS SANs.
    ip string[]
    IP address SANs.
    dns Sequence[str]
    DNS SANs.
    ip Sequence[str]
    IP address SANs.
    dns List<String>
    DNS SANs.
    ip List<String>
    IP address SANs.

    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.

    TlsCertMethodResponse

    Mode string
    Mode of TLS server certificate management.
    Automatic Pulumi.AzureNative.IoTOperations.Inputs.AutomaticCertMethodResponse
    Option 1 - Automatic TLS server certificate management with cert-manager.
    Manual Pulumi.AzureNative.IoTOperations.Inputs.X509ManualCertificateResponse
    Option 2 - Manual TLS server certificate management through a defined secret.
    Mode string
    Mode of TLS server certificate management.
    Automatic AutomaticCertMethodResponse
    Option 1 - Automatic TLS server certificate management with cert-manager.
    Manual X509ManualCertificateResponse
    Option 2 - Manual TLS server certificate management through a defined secret.
    mode String
    Mode of TLS server certificate management.
    automatic AutomaticCertMethodResponse
    Option 1 - Automatic TLS server certificate management with cert-manager.
    manual X509ManualCertificateResponse
    Option 2 - Manual TLS server certificate management through a defined secret.
    mode string
    Mode of TLS server certificate management.
    automatic AutomaticCertMethodResponse
    Option 1 - Automatic TLS server certificate management with cert-manager.
    manual X509ManualCertificateResponse
    Option 2 - Manual TLS server certificate management through a defined secret.
    mode str
    Mode of TLS server certificate management.
    automatic AutomaticCertMethodResponse
    Option 1 - Automatic TLS server certificate management with cert-manager.
    manual X509ManualCertificateResponse
    Option 2 - Manual TLS server certificate management through a defined secret.
    mode String
    Mode of TLS server certificate management.
    automatic Property Map
    Option 1 - Automatic TLS server certificate management with cert-manager.
    manual Property Map
    Option 2 - Manual TLS server certificate management through a defined secret.

    X509ManualCertificateResponse

    SecretRef string
    Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.
    SecretRef string
    Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.
    secretRef String
    Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.
    secretRef string
    Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.
    secret_ref str
    Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.
    secretRef String
    Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.

    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