azure-native.iotoperations.getBrokerListener
Explore with Pulumi AI
Get a BrokerListenerResource
Uses Azure REST API version 2024-11-01.
Other available API versions: 2024-07-01-preview, 2024-08-15-preview, 2024-09-15-preview, 2025-04-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native iotoperations [ApiVersion]. See the version guide for details.
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)
public static Output<GetBrokerListenerResult> getBrokerListener(GetBrokerListenerArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:iotoperations:getBrokerListener
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Broker
Name string - Name of broker.
 - Instance
Name string - Name of instance.
 - Listener
Name string - Name of Instance broker listener resource
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- Broker
Name string - Name of broker.
 - Instance
Name string - Name of instance.
 - Listener
Name string - Name of Instance broker listener resource
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- broker
Name String - Name of broker.
 - instance
Name String - Name of instance.
 - listener
Name String - Name of Instance broker listener resource
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 
- broker
Name string - Name of broker.
 - instance
Name string - Name of instance.
 - listener
Name string - Name of Instance broker listener resource
 - resource
Group stringName  - 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_ strname  - The name of the resource group. The name is case insensitive.
 
- broker
Name String - Name of broker.
 - instance
Name String - Name of instance.
 - listener
Name String - Name of Instance broker listener resource
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 
getBrokerListener Result
The following output properties are available:
- Azure
Api stringVersion  - The Azure API version of the resource.
 - Extended
Location Pulumi.Azure Native. Io TOperations. Outputs. Extended Location Response  - 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.
Azure Native. Io TOperations. Outputs. Broker Listener Properties Response  - The resource-specific properties for this resource.
 - System
Data Pulumi.Azure Native. Io TOperations. Outputs. System Data Response  - 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"
 
- Azure
Api stringVersion  - The Azure API version of the resource.
 - Extended
Location ExtendedLocation Response  - 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
Broker
Listener Properties Response  - The resource-specific properties for this resource.
 - System
Data SystemData Response  - 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"
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - extended
Location ExtendedLocation Response  - 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
Broker
Listener Properties Response  - The resource-specific properties for this resource.
 - system
Data SystemData Response  - 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"
 
- azure
Api stringVersion  - The Azure API version of the resource.
 - extended
Location ExtendedLocation Response  - 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
Broker
Listener Properties Response  - The resource-specific properties for this resource.
 - system
Data SystemData Response  - 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"
 
- azure_
api_ strversion  - The Azure API version of the resource.
 - extended_
location ExtendedLocation Response  - 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
Broker
Listener Properties Response  - The resource-specific properties for this resource.
 - system_
data SystemData Response  - 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"
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - extended
Location 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.
 - system
Data 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
BrokerListenerPropertiesResponse   
- Ports
List<Pulumi.
Azure Native. Io TOperations. Inputs. Listener Port Response>  - Ports on which this listener accepts client connections.
 - Provisioning
State string - The status of the last operation.
 - Service
Name string - Kubernetes Service name of this listener.
 - Service
Type string - Kubernetes Service type of this listener.
 
- Ports
[]Listener
Port Response  - Ports on which this listener accepts client connections.
 - Provisioning
State string - The status of the last operation.
 - Service
Name string - Kubernetes Service name of this listener.
 - Service
Type string - Kubernetes Service type of this listener.
 
- ports
List<Listener
Port Response>  - Ports on which this listener accepts client connections.
 - provisioning
State String - The status of the last operation.
 - service
Name String - Kubernetes Service name of this listener.
 - service
Type String - Kubernetes Service type of this listener.
 
- ports
Listener
Port Response[]  - Ports on which this listener accepts client connections.
 - provisioning
State string - The status of the last operation.
 - service
Name string - Kubernetes Service name of this listener.
 - service
Type string - Kubernetes Service type of this listener.
 
- ports
Sequence[Listener
Port Response]  - 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.
 
- ports List<Property Map>
 - Ports on which this listener accepts client connections.
 - provisioning
State String - The status of the last operation.
 - service
Name String - Kubernetes Service name of this listener.
 - service
Type String - Kubernetes Service type of this listener.
 
CertManagerCertificateSpecResponse    
- Issuer
Ref Pulumi.Azure Native. Io TOperations. Inputs. Cert Manager Issuer Ref Response  - 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.
 - Private
Key Pulumi.Azure Native. Io TOperations. Inputs. Cert Manager Private Key Response  - Type of certificate private key.
 - Renew
Before 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.
Azure Native. Io TOperations. Inputs. San For Cert Response  - Additional Subject Alternative Names (SANs) to include in the certificate.
 - Secret
Name 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 CertManager Issuer Ref Response  - 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.
 - Private
Key CertManager Private Key Response  - Type of certificate private key.
 - Renew
Before 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
San
For Cert Response  - Additional Subject Alternative Names (SANs) to include in the certificate.
 - Secret
Name 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 CertManager Issuer Ref Response  - 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.
 - private
Key CertManager Private Key Response  - Type of certificate private key.
 - renew
Before 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
San
For Cert Response  - Additional Subject Alternative Names (SANs) to include in the certificate.
 - secret
Name 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 CertManager Issuer Ref Response  - 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.
 - private
Key CertManager Private Key Response  - Type of certificate private key.
 - renew
Before 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
San
For Cert Response  - Additional Subject Alternative Names (SANs) to include in the certificate.
 - secret
Name 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 CertManager Issuer Ref Response  - 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 CertManager Private Key Response  - 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
San
For Cert Response  - Additional Subject Alternative Names (SANs) to include in the certificate.
 - secret_
name 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.
 
- issuer
Ref 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.
 - private
Key Property Map - Type of certificate private key.
 - renew
Before 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.
 - secret
Name 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.
 
CertManagerIssuerRefResponse    
CertManagerPrivateKeyResponse    
- Algorithm string
 - algorithm for private key.
 - Rotation
Policy string - cert-manager private key rotationPolicy.
 
- Algorithm string
 - algorithm for private key.
 - Rotation
Policy string - cert-manager private key rotationPolicy.
 
- algorithm String
 - algorithm for private key.
 - rotation
Policy String - cert-manager private key rotationPolicy.
 
- algorithm string
 - algorithm for private key.
 - rotation
Policy 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.
 - rotation
Policy String - cert-manager private key rotationPolicy.
 
ExtendedLocationResponse  
ListenerPortResponse  
- Port int
 - TCP port for accepting client connections.
 - Authentication
Ref string - Reference to client authentication settings. Omit to disable authentication.
 - string
 - Reference to client authorization settings. Omit to disable authorization.
 - Node
Port int - Kubernetes node port. Only relevant when this port is associated with a 
NodePortlistener. - Protocol string
 - Protocol to use for client connections.
 - Tls
Pulumi.
Azure Native. Io TOperations. Inputs. Tls Cert Method Response  - TLS server certificate settings for this port. Omit to disable TLS.
 
- Port int
 - TCP port for accepting client connections.
 - Authentication
Ref string - Reference to client authentication settings. Omit to disable authentication.
 - string
 - Reference to client authorization settings. Omit to disable authorization.
 - Node
Port int - Kubernetes node port. Only relevant when this port is associated with a 
NodePortlistener. - Protocol string
 - Protocol to use for client connections.
 - Tls
Tls
Cert Method Response  - TLS server certificate settings for this port. Omit to disable TLS.
 
- port Integer
 - TCP port for accepting client connections.
 - authentication
Ref String - Reference to client authentication settings. Omit to disable authentication.
 - String
 - Reference to client authorization settings. Omit to disable authorization.
 - node
Port Integer - Kubernetes node port. Only relevant when this port is associated with a 
NodePortlistener. - protocol String
 - Protocol to use for client connections.
 - tls
Tls
Cert Method Response  - TLS server certificate settings for this port. Omit to disable TLS.
 
- port number
 - TCP port for accepting client connections.
 - authentication
Ref string - Reference to client authentication settings. Omit to disable authentication.
 - string
 - Reference to client authorization settings. Omit to disable authorization.
 - node
Port number - Kubernetes node port. Only relevant when this port is associated with a 
NodePortlistener. - protocol string
 - Protocol to use for client connections.
 - tls
Tls
Cert Method Response  - 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.
 - 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 
NodePortlistener. - protocol str
 - Protocol to use for client connections.
 - tls
Tls
Cert Method Response  - TLS server certificate settings for this port. Omit to disable TLS.
 
- port Number
 - TCP port for accepting client connections.
 - authentication
Ref String - Reference to client authentication settings. Omit to disable authentication.
 - String
 - Reference to client authorization settings. Omit to disable authorization.
 - node
Port Number - Kubernetes node port. Only relevant when this port is associated with a 
NodePortlistener. - protocol String
 - Protocol to use for client connections.
 - tls Property Map
 - TLS server certificate settings for this port. Omit to disable TLS.
 
SanForCertResponse   
SystemDataResponse  
- Created
At string - The timestamp of resource creation (UTC).
 - Created
By string - The identity that created the resource.
 - Created
By stringType  - The type of identity that created the resource.
 - Last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - Last
Modified stringBy  - The identity that last modified the resource.
 - Last
Modified stringBy Type  - The type of identity that last modified the resource.
 
- Created
At string - The timestamp of resource creation (UTC).
 - Created
By string - The identity that created the resource.
 - Created
By stringType  - The type of identity that created the resource.
 - Last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - Last
Modified stringBy  - The identity that last modified the resource.
 - Last
Modified stringBy Type  - The type of identity that last modified the resource.
 
- created
At String - The timestamp of resource creation (UTC).
 - created
By String - The identity that created the resource.
 - created
By StringType  - The type of identity that created the resource.
 - last
Modified StringAt  - The timestamp of resource last modification (UTC)
 - last
Modified StringBy  - The identity that last modified the resource.
 - last
Modified StringBy Type  - The type of identity that last modified the resource.
 
- created
At string - The timestamp of resource creation (UTC).
 - created
By string - The identity that created the resource.
 - created
By stringType  - The type of identity that created the resource.
 - last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - last
Modified stringBy  - The identity that last modified the resource.
 - last
Modified stringBy Type  - The type of identity that last modified the resource.
 
- created_
at str - The timestamp of resource creation (UTC).
 - created_
by str - The identity that created the resource.
 - created_
by_ strtype  - The type of identity that created the resource.
 - last_
modified_ strat  - The timestamp of resource last modification (UTC)
 - last_
modified_ strby  - The identity that last modified the resource.
 - last_
modified_ strby_ type  - The type of identity that last modified the resource.
 
- created
At String - The timestamp of resource creation (UTC).
 - created
By String - The identity that created the resource.
 - created
By StringType  - The type of identity that created the resource.
 - last
Modified StringAt  - The timestamp of resource last modification (UTC)
 - last
Modified StringBy  - The identity that last modified the resource.
 - last
Modified StringBy Type  - The type of identity that last modified the resource.
 
TlsCertMethodResponse   
- Mode string
 - Mode of TLS server certificate management.
 - Cert
Manager Pulumi.Certificate Spec Azure Native. Io TOperations. Inputs. Cert Manager Certificate Spec Response  - Option 1 - Automatic TLS server certificate management with cert-manager.
 - Manual
Pulumi.
Azure Native. Io TOperations. Inputs. X509Manual Certificate Response  - Option 2 - Manual TLS server certificate management through a defined secret.
 
- Mode string
 - Mode of TLS server certificate management.
 - Cert
Manager CertCertificate Spec Manager Certificate Spec Response  - Option 1 - Automatic TLS server certificate management with cert-manager.
 - Manual
X509Manual
Certificate Response  - Option 2 - Manual TLS server certificate management through a defined secret.
 
- mode String
 - Mode of TLS server certificate management.
 - cert
Manager CertCertificate Spec Manager Certificate Spec Response  - Option 1 - Automatic TLS server certificate management with cert-manager.
 - manual
X509Manual
Certificate Response  - Option 2 - Manual TLS server certificate management through a defined secret.
 
- mode string
 - Mode of TLS server certificate management.
 - cert
Manager CertCertificate Spec Manager Certificate Spec Response  - Option 1 - Automatic TLS server certificate management with cert-manager.
 - manual
X509Manual
Certificate Response  - Option 2 - Manual TLS server certificate management through a defined secret.
 
- mode str
 - Mode of TLS server certificate management.
 - cert_
manager_ Certcertificate_ spec Manager Certificate Spec Response  - Option 1 - Automatic TLS server certificate management with cert-manager.
 - manual
X509Manual
Certificate Response  - Option 2 - Manual TLS server certificate management through a defined secret.
 
- mode String
 - Mode of TLS server certificate management.
 - cert
Manager Property MapCertificate Spec  - 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  
- Secret
Ref 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 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 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 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.
 
- secret
Ref 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