1. Packages
  2. Azure Native
  3. API Docs
  4. networkcloud
  5. getAccessBridge
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.16.0
published on Friday, Mar 20, 2026 by Pulumi
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.16.0
published on Friday, Mar 20, 2026 by Pulumi

    Get the properties of the provided access bridge.

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

    Using getAccessBridge

    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 getAccessBridge(args: GetAccessBridgeArgs, opts?: InvokeOptions): Promise<GetAccessBridgeResult>
    function getAccessBridgeOutput(args: GetAccessBridgeOutputArgs, opts?: InvokeOptions): Output<GetAccessBridgeResult>
    def get_access_bridge(access_bridge_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetAccessBridgeResult
    def get_access_bridge_output(access_bridge_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetAccessBridgeResult]
    func LookupAccessBridge(ctx *Context, args *LookupAccessBridgeArgs, opts ...InvokeOption) (*LookupAccessBridgeResult, error)
    func LookupAccessBridgeOutput(ctx *Context, args *LookupAccessBridgeOutputArgs, opts ...InvokeOption) LookupAccessBridgeResultOutput

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

    public static class GetAccessBridge 
    {
        public static Task<GetAccessBridgeResult> InvokeAsync(GetAccessBridgeArgs args, InvokeOptions? opts = null)
        public static Output<GetAccessBridgeResult> Invoke(GetAccessBridgeInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAccessBridgeResult> getAccessBridge(GetAccessBridgeArgs args, InvokeOptions options)
    public static Output<GetAccessBridgeResult> getAccessBridge(GetAccessBridgeArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:networkcloud:getAccessBridge
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccessBridgeName string
    The name of the access bridge.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AccessBridgeName string
    The name of the access bridge.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    accessBridgeName String
    The name of the access bridge.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    accessBridgeName string
    The name of the access bridge.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    access_bridge_name str
    The name of the access bridge.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    accessBridgeName String
    The name of the access bridge.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getAccessBridge Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    DetailedStatus string
    The detailed status reported by the access bridge.
    DetailedStatusMessage string
    The descriptive message that accompanies the detailed status.
    Endpoints List<Pulumi.AzureNative.NetworkCloud.Outputs.AccessBridgeEndpointResponse>
    The observed endpoints that clients should use to reach the access bridge.
    Etag string
    Resource ETag.
    ExtendedLocation Pulumi.AzureNative.NetworkCloud.Outputs.ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    NetworkId string
    The resource ID of the internal network in a layer 3 isolation domain containing the IP subnets to use.
    Protocol string
    The protocol advertised by the access bridge endpoints.
    ProvisioningState string
    The provisioning state of the access bridge.
    SystemData Pulumi.AzureNative.NetworkCloud.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"
    Ipv4ConnectedPrefix string
    The IPv4 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.
    Ipv6ConnectedPrefix string
    The IPv6 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.
    SecurityRules List<Pulumi.AzureNative.NetworkCloud.Outputs.AccessBridgeSecurityRuleResponse>
    The list of security rules enforced by the access bridge.
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    DetailedStatus string
    The detailed status reported by the access bridge.
    DetailedStatusMessage string
    The descriptive message that accompanies the detailed status.
    Endpoints []AccessBridgeEndpointResponse
    The observed endpoints that clients should use to reach the access bridge.
    Etag string
    Resource ETag.
    ExtendedLocation ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    NetworkId string
    The resource ID of the internal network in a layer 3 isolation domain containing the IP subnets to use.
    Protocol string
    The protocol advertised by the access bridge endpoints.
    ProvisioningState string
    The provisioning state of the access bridge.
    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"
    Ipv4ConnectedPrefix string
    The IPv4 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.
    Ipv6ConnectedPrefix string
    The IPv6 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.
    SecurityRules []AccessBridgeSecurityRuleResponse
    The list of security rules enforced by the access bridge.
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    detailedStatus String
    The detailed status reported by the access bridge.
    detailedStatusMessage String
    The descriptive message that accompanies the detailed status.
    endpoints List<AccessBridgeEndpointResponse>
    The observed endpoints that clients should use to reach the access bridge.
    etag String
    Resource ETag.
    extendedLocation ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    networkId String
    The resource ID of the internal network in a layer 3 isolation domain containing the IP subnets to use.
    protocol String
    The protocol advertised by the access bridge endpoints.
    provisioningState String
    The provisioning state of the access bridge.
    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"
    ipv4ConnectedPrefix String
    The IPv4 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.
    ipv6ConnectedPrefix String
    The IPv6 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.
    securityRules List<AccessBridgeSecurityRuleResponse>
    The list of security rules enforced by the access bridge.
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    detailedStatus string
    The detailed status reported by the access bridge.
    detailedStatusMessage string
    The descriptive message that accompanies the detailed status.
    endpoints AccessBridgeEndpointResponse[]
    The observed endpoints that clients should use to reach the access bridge.
    etag string
    Resource ETag.
    extendedLocation ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    networkId string
    The resource ID of the internal network in a layer 3 isolation domain containing the IP subnets to use.
    protocol string
    The protocol advertised by the access bridge endpoints.
    provisioningState string
    The provisioning state of the access bridge.
    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"
    ipv4ConnectedPrefix string
    The IPv4 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.
    ipv6ConnectedPrefix string
    The IPv6 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.
    securityRules AccessBridgeSecurityRuleResponse[]
    The list of security rules enforced by the access bridge.
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    detailed_status str
    The detailed status reported by the access bridge.
    detailed_status_message str
    The descriptive message that accompanies the detailed status.
    endpoints Sequence[AccessBridgeEndpointResponse]
    The observed endpoints that clients should use to reach the access bridge.
    etag str
    Resource ETag.
    extended_location ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    network_id str
    The resource ID of the internal network in a layer 3 isolation domain containing the IP subnets to use.
    protocol str
    The protocol advertised by the access bridge endpoints.
    provisioning_state str
    The provisioning state of the access bridge.
    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"
    ipv4_connected_prefix str
    The IPv4 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.
    ipv6_connected_prefix str
    The IPv6 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.
    security_rules Sequence[AccessBridgeSecurityRuleResponse]
    The list of security rules enforced by the access bridge.
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    detailedStatus String
    The detailed status reported by the access bridge.
    detailedStatusMessage String
    The descriptive message that accompanies the detailed status.
    endpoints List<Property Map>
    The observed endpoints that clients should use to reach the access bridge.
    etag String
    Resource ETag.
    extendedLocation Property Map
    The extended location of the cluster associated with the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    networkId String
    The resource ID of the internal network in a layer 3 isolation domain containing the IP subnets to use.
    protocol String
    The protocol advertised by the access bridge endpoints.
    provisioningState String
    The provisioning state of the access bridge.
    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"
    ipv4ConnectedPrefix String
    The IPv4 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.
    ipv6ConnectedPrefix String
    The IPv6 subnet from which the access bridge allocates an address. This subnet must be part of the internal network specified by networkId.
    securityRules List<Property Map>
    The list of security rules enforced by the access bridge.
    tags Map<String>
    Resource tags.

    Supporting Types

    AccessBridgeEndpointResponse

    Fqdn string
    The fully qualified domain name used to describe the certificate name for the endpoint.
    Ipv4Address string
    The IPv4 address associated with the endpoint.
    Ipv6Address string
    The IPv6 address associated with the endpoint.
    Name string
    The name that identifies the type of endpoint (for example VIP or host).
    Fqdn string
    The fully qualified domain name used to describe the certificate name for the endpoint.
    Ipv4Address string
    The IPv4 address associated with the endpoint.
    Ipv6Address string
    The IPv6 address associated with the endpoint.
    Name string
    The name that identifies the type of endpoint (for example VIP or host).
    fqdn String
    The fully qualified domain name used to describe the certificate name for the endpoint.
    ipv4Address String
    The IPv4 address associated with the endpoint.
    ipv6Address String
    The IPv6 address associated with the endpoint.
    name String
    The name that identifies the type of endpoint (for example VIP or host).
    fqdn string
    The fully qualified domain name used to describe the certificate name for the endpoint.
    ipv4Address string
    The IPv4 address associated with the endpoint.
    ipv6Address string
    The IPv6 address associated with the endpoint.
    name string
    The name that identifies the type of endpoint (for example VIP or host).
    fqdn str
    The fully qualified domain name used to describe the certificate name for the endpoint.
    ipv4_address str
    The IPv4 address associated with the endpoint.
    ipv6_address str
    The IPv6 address associated with the endpoint.
    name str
    The name that identifies the type of endpoint (for example VIP or host).
    fqdn String
    The fully qualified domain name used to describe the certificate name for the endpoint.
    ipv4Address String
    The IPv4 address associated with the endpoint.
    ipv6Address String
    The IPv6 address associated with the endpoint.
    name String
    The name that identifies the type of endpoint (for example VIP or host).

    AccessBridgeSecurityRuleResponse

    Direction string
    The direction of allowed network traffic based on the rule.
    Port string
    The source or destination port or port range. Example 24562 or 24562-24570.
    Description string
    The user provided value describing this rule.
    Ipv4Addresses List<string>
    The set of IPv4 addresses permitted as the source or destination of the security rule. For as single address, utilize a /32 (CIDR notation). One or both Ipv4Addresses and Ipv6Addresses must be specified. Example formats: 10.10.10.10-10.10.10.20 or 10.10.10.10/24.
    Ipv6Addresses List<string>
    The set of IPv6 addresses permitted as the source or destination of the security rule. For as single address, utilize a /128 (CIDR notation). One or both Ipv4Addresses and Ipv6Addresses must be specified. Example formats: 2001:db8:abcd::1-2001:db8:abcd::ff or 2001:db8:abcd::1/64.
    Direction string
    The direction of allowed network traffic based on the rule.
    Port string
    The source or destination port or port range. Example 24562 or 24562-24570.
    Description string
    The user provided value describing this rule.
    Ipv4Addresses []string
    The set of IPv4 addresses permitted as the source or destination of the security rule. For as single address, utilize a /32 (CIDR notation). One or both Ipv4Addresses and Ipv6Addresses must be specified. Example formats: 10.10.10.10-10.10.10.20 or 10.10.10.10/24.
    Ipv6Addresses []string
    The set of IPv6 addresses permitted as the source or destination of the security rule. For as single address, utilize a /128 (CIDR notation). One or both Ipv4Addresses and Ipv6Addresses must be specified. Example formats: 2001:db8:abcd::1-2001:db8:abcd::ff or 2001:db8:abcd::1/64.
    direction String
    The direction of allowed network traffic based on the rule.
    port String
    The source or destination port or port range. Example 24562 or 24562-24570.
    description String
    The user provided value describing this rule.
    ipv4Addresses List<String>
    The set of IPv4 addresses permitted as the source or destination of the security rule. For as single address, utilize a /32 (CIDR notation). One or both Ipv4Addresses and Ipv6Addresses must be specified. Example formats: 10.10.10.10-10.10.10.20 or 10.10.10.10/24.
    ipv6Addresses List<String>
    The set of IPv6 addresses permitted as the source or destination of the security rule. For as single address, utilize a /128 (CIDR notation). One or both Ipv4Addresses and Ipv6Addresses must be specified. Example formats: 2001:db8:abcd::1-2001:db8:abcd::ff or 2001:db8:abcd::1/64.
    direction string
    The direction of allowed network traffic based on the rule.
    port string
    The source or destination port or port range. Example 24562 or 24562-24570.
    description string
    The user provided value describing this rule.
    ipv4Addresses string[]
    The set of IPv4 addresses permitted as the source or destination of the security rule. For as single address, utilize a /32 (CIDR notation). One or both Ipv4Addresses and Ipv6Addresses must be specified. Example formats: 10.10.10.10-10.10.10.20 or 10.10.10.10/24.
    ipv6Addresses string[]
    The set of IPv6 addresses permitted as the source or destination of the security rule. For as single address, utilize a /128 (CIDR notation). One or both Ipv4Addresses and Ipv6Addresses must be specified. Example formats: 2001:db8:abcd::1-2001:db8:abcd::ff or 2001:db8:abcd::1/64.
    direction str
    The direction of allowed network traffic based on the rule.
    port str
    The source or destination port or port range. Example 24562 or 24562-24570.
    description str
    The user provided value describing this rule.
    ipv4_addresses Sequence[str]
    The set of IPv4 addresses permitted as the source or destination of the security rule. For as single address, utilize a /32 (CIDR notation). One or both Ipv4Addresses and Ipv6Addresses must be specified. Example formats: 10.10.10.10-10.10.10.20 or 10.10.10.10/24.
    ipv6_addresses Sequence[str]
    The set of IPv6 addresses permitted as the source or destination of the security rule. For as single address, utilize a /128 (CIDR notation). One or both Ipv4Addresses and Ipv6Addresses must be specified. Example formats: 2001:db8:abcd::1-2001:db8:abcd::ff or 2001:db8:abcd::1/64.
    direction String
    The direction of allowed network traffic based on the rule.
    port String
    The source or destination port or port range. Example 24562 or 24562-24570.
    description String
    The user provided value describing this rule.
    ipv4Addresses List<String>
    The set of IPv4 addresses permitted as the source or destination of the security rule. For as single address, utilize a /32 (CIDR notation). One or both Ipv4Addresses and Ipv6Addresses must be specified. Example formats: 10.10.10.10-10.10.10.20 or 10.10.10.10/24.
    ipv6Addresses List<String>
    The set of IPv6 addresses permitted as the source or destination of the security rule. For as single address, utilize a /128 (CIDR notation). One or both Ipv4Addresses and Ipv6Addresses must be specified. Example formats: 2001:db8:abcd::1-2001:db8:abcd::ff or 2001:db8:abcd::1/64.

    ExtendedLocationResponse

    Name string
    The resource ID of the extended location on which the resource will be created.
    Type string
    The extended location type, for example, CustomLocation.
    Name string
    The resource ID of the extended location on which the resource will be created.
    Type string
    The extended location type, for example, CustomLocation.
    name String
    The resource ID of the extended location on which the resource will be created.
    type String
    The extended location type, for example, CustomLocation.
    name string
    The resource ID of the extended location on which the resource will be created.
    type string
    The extended location type, for example, CustomLocation.
    name str
    The resource ID of the extended location on which the resource will be created.
    type str
    The extended location type, for example, CustomLocation.
    name String
    The resource ID of the extended location on which the resource will be created.
    type String
    The extended location type, for example, CustomLocation.

    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 v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.16.0
    published on Friday, Mar 20, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.