Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. hybridcompute
  5. getGateway
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.hybridcompute.getGateway

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Retrieves information about the view of a gateway.

Uses Azure REST API version 2024-07-31-preview.

Other available API versions: 2024-03-31-preview, 2024-05-20-preview, 2024-09-10-preview, 2024-11-10-preview, 2025-01-13. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native hybridcompute [ApiVersion]. See the version guide for details.

Using getGateway

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 getGateway(args: GetGatewayArgs, opts?: InvokeOptions): Promise<GetGatewayResult>
function getGatewayOutput(args: GetGatewayOutputArgs, opts?: InvokeOptions): Output<GetGatewayResult>
Copy
def get_gateway(gateway_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetGatewayResult
def get_gateway_output(gateway_name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetGatewayResult]
Copy
func LookupGateway(ctx *Context, args *LookupGatewayArgs, opts ...InvokeOption) (*LookupGatewayResult, error)
func LookupGatewayOutput(ctx *Context, args *LookupGatewayOutputArgs, opts ...InvokeOption) LookupGatewayResultOutput
Copy

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

public static class GetGateway 
{
    public static Task<GetGatewayResult> InvokeAsync(GetGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayResult> Invoke(GetGatewayInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)
public static Output<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:hybridcompute:getGateway
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Gateway.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
GatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Gateway.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
gatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
gatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
gateway_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Gateway.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
gatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getGateway Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
GatewayEndpoint string
The endpoint fqdn for the Gateway.
GatewayId string
A unique, immutable, identifier for the Gateway.
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
ProvisioningState string
The provisioning state, which only appears in the response.
SystemData Pulumi.AzureNative.HybridCompute.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"
AllowedFeatures List<string>
Specifies the list of features that are enabled for this Gateway.
GatewayType string
The type of the Gateway resource.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
GatewayEndpoint string
The endpoint fqdn for the Gateway.
GatewayId string
A unique, immutable, identifier for the Gateway.
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
ProvisioningState string
The provisioning state, which only appears in the response.
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"
AllowedFeatures []string
Specifies the list of features that are enabled for this Gateway.
GatewayType string
The type of the Gateway resource.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
gatewayEndpoint String
The endpoint fqdn for the Gateway.
gatewayId String
A unique, immutable, identifier for the Gateway.
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
provisioningState String
The provisioning state, which only appears in the response.
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"
allowedFeatures List<String>
Specifies the list of features that are enabled for this Gateway.
gatewayType String
The type of the Gateway resource.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
gatewayEndpoint string
The endpoint fqdn for the Gateway.
gatewayId string
A unique, immutable, identifier for the Gateway.
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
provisioningState string
The provisioning state, which only appears in the response.
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"
allowedFeatures string[]
Specifies the list of features that are enabled for this Gateway.
gatewayType string
The type of the Gateway resource.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
gateway_endpoint str
The endpoint fqdn for the Gateway.
gateway_id str
A unique, immutable, identifier for the Gateway.
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
provisioning_state str
The provisioning state, which only appears in the response.
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"
allowed_features Sequence[str]
Specifies the list of features that are enabled for this Gateway.
gateway_type str
The type of the Gateway resource.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
gatewayEndpoint String
The endpoint fqdn for the Gateway.
gatewayId String
A unique, immutable, identifier for the Gateway.
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
provisioningState String
The provisioning state, which only appears in the response.
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"
allowedFeatures List<String>
Specifies the list of features that are enabled for this Gateway.
gatewayType String
The type of the Gateway resource.
tags Map<String>
Resource tags.

Supporting Types

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native