Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. listGatewayKeys
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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.listGatewayKeys

Explore with Pulumi AI

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.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Retrieves gateway keys.

    Uses Azure REST API version 2022-09-01-preview.

    Other available API versions: 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the version guide for details.

    Using listGatewayKeys

    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 listGatewayKeys(args: ListGatewayKeysArgs, opts?: InvokeOptions): Promise<ListGatewayKeysResult>
function listGatewayKeysOutput(args: ListGatewayKeysOutputArgs, opts?: InvokeOptions): Output<ListGatewayKeysResult>
    def list_gateway_keys(gateway_id: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      service_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> ListGatewayKeysResult
def list_gateway_keys_output(gateway_id: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      service_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[ListGatewayKeysResult]
    func ListGatewayKeys(ctx *Context, args *ListGatewayKeysArgs, opts ...InvokeOption) (*ListGatewayKeysResult, error)
func ListGatewayKeysOutput(ctx *Context, args *ListGatewayKeysOutputArgs, opts ...InvokeOption) ListGatewayKeysResultOutput

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

    public static class ListGatewayKeys 
{
    public static Task<ListGatewayKeysResult> InvokeAsync(ListGatewayKeysArgs args, InvokeOptions? opts = null)
    public static Output<ListGatewayKeysResult> Invoke(ListGatewayKeysInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<ListGatewayKeysResult> listGatewayKeys(ListGatewayKeysArgs args, InvokeOptions options)
public static Output<ListGatewayKeysResult> listGatewayKeys(ListGatewayKeysArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:apimanagement:listGatewayKeys
  arguments:
    # arguments dictionary

    The following arguments are supported:

    GatewayId string
    Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    GatewayId string
    Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    gatewayId String
    Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    gatewayId string
    Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    gateway_id str
    Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    service_name str
    The name of the API Management service.
    gatewayId String
    Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.

    listGatewayKeys Result

    The following output properties are available:

    Primary string
    Primary gateway key.
    Secondary string
    Secondary gateway key.
    Primary string
    Primary gateway key.
    Secondary string
    Secondary gateway key.
    primary String
    Primary gateway key.
    secondary String
    Secondary gateway key.
    primary string
    Primary gateway key.
    secondary string
    Secondary gateway key.
    primary str
    Primary gateway key.
    secondary str
    Secondary gateway key.
    primary String
    Primary gateway key.
    secondary String
    Secondary gateway key.

    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.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native