@pulumi/azure-native/apicenter/api.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 inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
 * API entity.
 *
 * Uses Azure REST API version 2024-03-15-preview. In version 2.x of the Azure Native provider, it used API version 2024-03-01.
 *
 * 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 class Api extends pulumi.CustomResource {
    /**
     * Get an existing Api resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Api;
    /**
     * Returns true if the given object is an instance of Api.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is Api;
    /**
     * The Azure API version of the resource.
     */
    readonly azureApiVersion: pulumi.Output<string>;
    /**
     * The set of contacts
     */
    readonly contacts: pulumi.Output<outputs.apicenter.ContactResponse[] | undefined>;
    /**
     * The custom metadata defined for API catalog entities.
     */
    readonly customProperties: pulumi.Output<any | undefined>;
    /**
     * Description of the API.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The set of external documentation
     */
    readonly externalDocumentation: pulumi.Output<outputs.apicenter.ExternalDocumentationResponse[] | undefined>;
    /**
     * Kind of API. For example, REST or GraphQL.
     */
    readonly kind: pulumi.Output<string>;
    /**
     * The license information for the API.
     */
    readonly license: pulumi.Output<outputs.apicenter.LicenseResponse | undefined>;
    /**
     * Current lifecycle stage of the API.
     */
    readonly lifecycleStage: pulumi.Output<string>;
    /**
     * The name of the resource
     */
    readonly name: pulumi.Output<string>;
    /**
     * Short description of the API.
     */
    readonly summary: pulumi.Output<string | undefined>;
    /**
     * Azure Resource Manager metadata containing createdBy and modifiedBy information.
     */
    readonly systemData: pulumi.Output<outputs.apicenter.SystemDataResponse>;
    /**
     * Terms of service for the API.
     */
    readonly termsOfService: pulumi.Output<outputs.apicenter.TermsOfServiceResponse | undefined>;
    /**
     * API title.
     */
    readonly title: pulumi.Output<string>;
    /**
     * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
     */
    readonly type: pulumi.Output<string>;
    /**
     * Create a Api resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: ApiArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * The set of arguments for constructing a Api resource.
 */
export interface ApiArgs {
    /**
     * The name of the API.
     */
    apiName?: pulumi.Input<string>;
    /**
     * The set of contacts
     */
    contacts?: pulumi.Input<pulumi.Input<inputs.apicenter.ContactArgs>[]>;
    /**
     * The custom metadata defined for API catalog entities.
     */
    customProperties?: any;
    /**
     * Description of the API.
     */
    description?: pulumi.Input<string>;
    /**
     * The set of external documentation
     */
    externalDocumentation?: pulumi.Input<pulumi.Input<inputs.apicenter.ExternalDocumentationArgs>[]>;
    /**
     * Kind of API. For example, REST or GraphQL.
     */
    kind: pulumi.Input<string | enums.apicenter.ApiKind>;
    /**
     * The license information for the API.
     */
    license?: pulumi.Input<inputs.apicenter.LicenseArgs>;
    /**
     * 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>;
    /**
     * Short description of the API.
     */
    summary?: pulumi.Input<string>;
    /**
     * Terms of service for the API.
     */
    termsOfService?: pulumi.Input<inputs.apicenter.TermsOfServiceArgs>;
    /**
     * API title.
     */
    title: pulumi.Input<string>;
    /**
     * The name of the workspace.
     */
    workspaceName: pulumi.Input<string>;
}