@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.14 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets an API Management gateway resource description.
*
* Uses Azure REST API version 2024-06-01-preview.
*
* Other available API versions: 2023-09-01-preview, 2024-05-01. 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getApiGateway(args: GetApiGatewayArgs, opts?: pulumi.InvokeOptions): Promise<GetApiGatewayResult>;
export interface GetApiGatewayArgs {
/**
* The name of the API Management gateway.
*/
gatewayName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* A single API Management gateway resource in List or Get response.
*/
export interface GetApiGatewayResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Information regarding how the gateway should integrate with backend systems.
*/
readonly backend?: outputs.apimanagement.BackendConfigurationResponse;
/**
* Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
*/
readonly configurationApi?: outputs.apimanagement.GatewayConfigurationApiResponse;
/**
* Creation UTC date of the API Management gateway.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
*/
readonly createdAtUtc: string;
/**
* ETag of the resource.
*/
readonly etag: string;
/**
* Information regarding how the gateway should be exposed.
*/
readonly frontend?: outputs.apimanagement.FrontendConfigurationResponse;
/**
* Resource ID.
*/
readonly id: string;
/**
* Resource location.
*/
readonly location: string;
/**
* Resource name.
*/
readonly name: string;
/**
* The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
*/
readonly provisioningState: string;
/**
* SKU properties of the API Management gateway.
*/
readonly sku: outputs.apimanagement.ApiManagementGatewaySkuPropertiesResponse;
/**
* Metadata pertaining to creation and last modification of the resource.
*/
readonly systemData: outputs.apimanagement.SystemDataResponse;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
*/
readonly targetProvisioningState: string;
/**
* Resource type for API Management resource is set to Microsoft.ApiManagement.
*/
readonly type: string;
/**
* The type of VPN in which API Management gateway needs to be configured in.
*/
readonly virtualNetworkType?: string;
}
/**
* Gets an API Management gateway resource description.
*
* Uses Azure REST API version 2024-06-01-preview.
*
* Other available API versions: 2023-09-01-preview, 2024-05-01. 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getApiGatewayOutput(args: GetApiGatewayOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetApiGatewayResult>;
export interface GetApiGatewayOutputArgs {
/**
* The name of the API Management gateway.
*/
gatewayName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}