Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Azure Native
  4. API Docs
  5. azurestackhci
  6. getInboundRule
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.26.0
published on Thursday, Aug 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.azurestackhci.getInboundRule

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.26.0
published on Thursday, Aug 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    The operation to get an inbound rule.

    Uses Azure REST API version 2026-04-01-preview.

    Using getInboundRule

    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 getInboundRule(args: GetInboundRuleArgs, opts?: InvokeOptions): Promise<GetInboundRuleResult>
function getInboundRuleOutput(args: GetInboundRuleOutputArgs, opts?: InvokeOutputOptions): Output<GetInboundRuleResult>
    def get_inbound_rule(inbound_rule_name: Optional[str] = None,
                     nat_gateway_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetInboundRuleResult
def get_inbound_rule_output(inbound_rule_name: pulumi.Input[Optional[str]] = None,
                     nat_gateway_name: pulumi.Input[Optional[str]] = None,
                     resource_group_name: pulumi.Input[Optional[str]] = None,
                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetInboundRuleResult]
    func LookupInboundRule(ctx *Context, args *LookupInboundRuleArgs, opts ...InvokeOption) (*LookupInboundRuleResult, error)
func LookupInboundRuleOutput(ctx *Context, args *LookupInboundRuleOutputArgs, opts ...InvokeOption) LookupInboundRuleResultOutput

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

    public static class GetInboundRule 
{
    public static Task<GetInboundRuleResult> InvokeAsync(GetInboundRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetInboundRuleResult> Invoke(GetInboundRuleInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetInboundRuleResult> Invoke(GetInboundRuleInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetInboundRuleResult> getInboundRule(GetInboundRuleArgs args, InvokeOptions options)
public static Output<GetInboundRuleResult> getInboundRule(GetInboundRuleArgs args, InvokeOptions options)
public static Output<GetInboundRuleResult> getInboundRule(GetInboundRuleArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: azure-native:azurestackhci:getInboundRule
  arguments:
    # arguments dictionary
    data "azure-native_azurestackhci_get_inbound_rule" "name" {
    # arguments
}

    The following arguments are supported:

    InboundRuleName string
    Name of the inbound rule
    NatGatewayName string
    Name of the nat gateway
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    InboundRuleName string
    Name of the inbound rule
    NatGatewayName string
    Name of the nat gateway
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    inbound_rule_name string
    Name of the inbound rule
    nat_gateway_name string
    Name of the nat gateway
    resource_group_name string
    The name of the resource group. The name is case insensitive.
    inboundRuleName String
    Name of the inbound rule
    natGatewayName String
    Name of the nat gateway
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    inboundRuleName string
    Name of the inbound rule
    natGatewayName string
    Name of the nat gateway
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    inbound_rule_name str
    Name of the inbound rule
    nat_gateway_name str
    Name of the nat gateway
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    inboundRuleName String
    Name of the inbound rule
    natGatewayName String
    Name of the nat gateway
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getInboundRule Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version 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.AzureStackHCI.Outputs.InboundRulePropertiesResponse
    The resource-specific properties for this resource.
    SystemData Pulumi.AzureNative.AzureStackHCI.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 Pulumi.AzureNative.AzureStackHCI.Outputs.ExtendedLocationResponse
    The extendedLocation of the resource.
    AzureApiVersion string
    The Azure API version 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 InboundRulePropertiesResponse
    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
    The extendedLocation of the resource.
    azure_api_version string
    The Azure API version 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 object
    The resource-specific properties for this resource.
    system_data object
    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 object
    The extendedLocation of the resource.
    azureApiVersion String
    The Azure API version 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 InboundRulePropertiesResponse
    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
    The extendedLocation of the resource.
    azureApiVersion string
    The Azure API version 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 InboundRulePropertiesResponse
    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
    The extendedLocation of the resource.
    azure_api_version str
    The Azure API version 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 InboundRulePropertiesResponse
    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"
    extended_location ExtendedLocationResponse
    The extendedLocation of the resource.
    azureApiVersion String
    The Azure API version 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"
    extendedLocation Property Map
    The extendedLocation of the resource.

    Supporting Types

    ExtendedLocationResponse

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

    IPConfigurationArmReferenceResponse

    ResourceId string
    The Azure Resource ID of an IPConfiguration resource
    ResourceId string
    The Azure Resource ID of an IPConfiguration resource
    resource_id string
    The Azure Resource ID of an IPConfiguration resource
    resourceId String
    The Azure Resource ID of an IPConfiguration resource
    resourceId string
    The Azure Resource ID of an IPConfiguration resource
    resource_id str
    The Azure Resource ID of an IPConfiguration resource
    resourceId String
    The Azure Resource ID of an IPConfiguration resource

    InboundRulePropertiesResponse

    BackendIPConfiguration Pulumi.AzureNative.AzureStackHCI.Inputs.IPConfigurationArmReferenceResponse
    IP configuration for the target backend.
    BackendPort int
    backend Port for the inbound rule
    FrontendPort int
    Frontend Port for the inbound rule
    Protocol string
    Protocol for the NAT rule
    ProvisioningState string
    Provisioning state of the inbound rule
    PublicIPAddress Pulumi.AzureNative.AzureStackHCI.Inputs.PublicIPAddressArmReferenceResponse
    Public IP Address for this NAT rule
    Status Pulumi.AzureNative.AzureStackHCI.Inputs.InboundRuleStatusResponse
    The observed state of Inbound Rule
    BackendIPConfiguration IPConfigurationArmReferenceResponse
    IP configuration for the target backend.
    BackendPort int
    backend Port for the inbound rule
    FrontendPort int
    Frontend Port for the inbound rule
    Protocol string
    Protocol for the NAT rule
    ProvisioningState string
    Provisioning state of the inbound rule
    PublicIPAddress PublicIPAddressArmReferenceResponse
    Public IP Address for this NAT rule
    Status InboundRuleStatusResponse
    The observed state of Inbound Rule
    backend_ip_configuration object
    IP configuration for the target backend.
    backend_port number
    backend Port for the inbound rule
    frontend_port number
    Frontend Port for the inbound rule
    protocol string
    Protocol for the NAT rule
    provisioning_state string
    Provisioning state of the inbound rule
    public_ip_address object
    Public IP Address for this NAT rule
    status object
    The observed state of Inbound Rule
    backendIPConfiguration IPConfigurationArmReferenceResponse
    IP configuration for the target backend.
    backendPort Integer
    backend Port for the inbound rule
    frontendPort Integer
    Frontend Port for the inbound rule
    protocol String
    Protocol for the NAT rule
    provisioningState String
    Provisioning state of the inbound rule
    publicIPAddress PublicIPAddressArmReferenceResponse
    Public IP Address for this NAT rule
    status InboundRuleStatusResponse
    The observed state of Inbound Rule
    backendIPConfiguration IPConfigurationArmReferenceResponse
    IP configuration for the target backend.
    backendPort number
    backend Port for the inbound rule
    frontendPort number
    Frontend Port for the inbound rule
    protocol string
    Protocol for the NAT rule
    provisioningState string
    Provisioning state of the inbound rule
    publicIPAddress PublicIPAddressArmReferenceResponse
    Public IP Address for this NAT rule
    status InboundRuleStatusResponse
    The observed state of Inbound Rule
    backend_ip_configuration IPConfigurationArmReferenceResponse
    IP configuration for the target backend.
    backend_port int
    backend Port for the inbound rule
    frontend_port int
    Frontend Port for the inbound rule
    protocol str
    Protocol for the NAT rule
    provisioning_state str
    Provisioning state of the inbound rule
    public_ip_address PublicIPAddressArmReferenceResponse
    Public IP Address for this NAT rule
    status InboundRuleStatusResponse
    The observed state of Inbound Rule
    backendIPConfiguration Property Map
    IP configuration for the target backend.
    backendPort Number
    backend Port for the inbound rule
    frontendPort Number
    Frontend Port for the inbound rule
    protocol String
    Protocol for the NAT rule
    provisioningState String
    Provisioning state of the inbound rule
    publicIPAddress Property Map
    Public IP Address for this NAT rule
    status Property Map
    The observed state of Inbound Rule

    InboundRuleStatusProvisioningStatusResponse

    Status string
    The status of the operation performed on the inbound rule [Succeeded, Failed, InProgress]
    OperationId string
    The ID of the operation performed on the inbound rule
    Status string
    The status of the operation performed on the inbound rule [Succeeded, Failed, InProgress]
    OperationId string
    The ID of the operation performed on the inbound rule
    status string
    The status of the operation performed on the inbound rule [Succeeded, Failed, InProgress]
    operation_id string
    The ID of the operation performed on the inbound rule
    status String
    The status of the operation performed on the inbound rule [Succeeded, Failed, InProgress]
    operationId String
    The ID of the operation performed on the inbound rule
    status string
    The status of the operation performed on the inbound rule [Succeeded, Failed, InProgress]
    operationId string
    The ID of the operation performed on the inbound rule
    status str
    The status of the operation performed on the inbound rule [Succeeded, Failed, InProgress]
    operation_id str
    The ID of the operation performed on the inbound rule
    status String
    The status of the operation performed on the inbound rule [Succeeded, Failed, InProgress]
    operationId String
    The ID of the operation performed on the inbound rule

    InboundRuleStatusResponse

    ErrorCode string
    InboundRule provisioning error code
    ErrorMessage string
    Descriptive error message
    ProvisioningStatus Pulumi.AzureNative.AzureStackHCI.Inputs.InboundRuleStatusProvisioningStatusResponse
    InboundRule provisioning status
    ErrorCode string
    InboundRule provisioning error code
    ErrorMessage string
    Descriptive error message
    ProvisioningStatus InboundRuleStatusProvisioningStatusResponse
    InboundRule provisioning status
    error_code string
    InboundRule provisioning error code
    error_message string
    Descriptive error message
    provisioning_status object
    InboundRule provisioning status
    errorCode String
    InboundRule provisioning error code
    errorMessage String
    Descriptive error message
    provisioningStatus InboundRuleStatusProvisioningStatusResponse
    InboundRule provisioning status
    errorCode string
    InboundRule provisioning error code
    errorMessage string
    Descriptive error message
    provisioningStatus InboundRuleStatusProvisioningStatusResponse
    InboundRule provisioning status
    error_code str
    InboundRule provisioning error code
    error_message str
    Descriptive error message
    provisioning_status InboundRuleStatusProvisioningStatusResponse
    InboundRule provisioning status
    errorCode String
    InboundRule provisioning error code
    errorMessage String
    Descriptive error message
    provisioningStatus Property Map
    InboundRule provisioning status

    PublicIPAddressArmReferenceResponse

    ResourceId string
    The Azure Resource ID of a Public IP resource
    ResourceId string
    The Azure Resource ID of a Public IP resource
    resource_id string
    The Azure Resource ID of a Public IP resource
    resourceId String
    The Azure Resource ID of a Public IP resource
    resourceId string
    The Azure Resource ID of a Public IP resource
    resource_id str
    The Azure Resource ID of a Public IP resource
    resourceId String
    The Azure Resource ID of a Public IP resource

    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.
    created_at string
    The timestamp of resource creation (UTC).
    created_by string
    The identity that created the resource.
    created_by_type string
    The type of identity that created the resource.
    last_modified_at string
    The timestamp of resource last modification (UTC)
    last_modified_by string
    The identity that last modified the resource.
    last_modified_by_type 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 v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.26.0
    published on Thursday, Aug 13, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial