@pulumi/azure-native/apicenter/getApi.d.ts

[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [![Python version](https://badge.fury.io/py/pu

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Returns details of the API.
 *
 * Uses Azure REST API version 2024-03-15-preview.
 *
 * Other available API versions: 2024-03-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native apicenter [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
 */
export declare function getApi(args: GetApiArgs, opts?: pulumi.InvokeOptions): Promise<GetApiResult>;
export interface GetApiArgs {
    /**
     * The name of the API.
     */
    apiName: string;
    /**
     * The name of the resource group. The name is case insensitive.
     */
    resourceGroupName: string;
    /**
     * The name of Azure API Center service.
     */
    serviceName: string;
    /**
     * The name of the workspace.
     */
    workspaceName: string;
}
/**
 * API entity.
 */
export interface GetApiResult {
    /**
     * The Azure API version of the resource.
     */
    readonly azureApiVersion: string;
    /**
     * The set of contacts
     */
    readonly contacts?: outputs.apicenter.ContactResponse[];
    /**
     * The custom metadata defined for API catalog entities.
     */
    readonly customProperties?: any;
    /**
     * Description of the API.
     */
    readonly description?: string;
    /**
     * The set of external documentation
     */
    readonly externalDocumentation?: outputs.apicenter.ExternalDocumentationResponse[];
    /**
     * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
     */
    readonly id: string;
    /**
     * Kind of API. For example, REST or GraphQL.
     */
    readonly kind: string;
    /**
     * The license information for the API.
     */
    readonly license?: outputs.apicenter.LicenseResponse;
    /**
     * Current lifecycle stage of the API.
     */
    readonly lifecycleStage: string;
    /**
     * The name of the resource
     */
    readonly name: string;
    /**
     * Short description of the API.
     */
    readonly summary?: string;
    /**
     * Azure Resource Manager metadata containing createdBy and modifiedBy information.
     */
    readonly systemData: outputs.apicenter.SystemDataResponse;
    /**
     * Terms of service for the API.
     */
    readonly termsOfService?: outputs.apicenter.TermsOfServiceResponse;
    /**
     * API title.
     */
    readonly title: string;
    /**
     * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
     */
    readonly type: string;
}
/**
 * Returns details of the API.
 *
 * Uses Azure REST API version 2024-03-15-preview.
 *
 * Other available API versions: 2024-03-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native apicenter [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
 */
export declare function getApiOutput(args: GetApiOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetApiResult>;
export interface GetApiOutputArgs {
    /**
     * The name of the API.
     */
    apiName: pulumi.Input<string>;
    /**
     * The name of the resource group. The name is case insensitive.
     */
    resourceGroupName: pulumi.Input<string>;
    /**
     * The name of Azure API Center service.
     */
    serviceName: pulumi.Input<string>;
    /**
     * The name of the workspace.
     */
    workspaceName: pulumi.Input<string>;
}