@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 5.91 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Backend details.
*
* Uses Azure REST API version 2024-06-01-preview. In version 2.x of the Azure Native provider, it used API version 2023-09-01-preview.
*
* Other available API versions: 2023-09-01-preview, 2024-05-01, 2024-10-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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class WorkspaceBackend extends pulumi.CustomResource {
/**
* Get an existing WorkspaceBackend 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): WorkspaceBackend;
/**
* Returns true if the given object is an instance of WorkspaceBackend. 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 WorkspaceBackend;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Backend Circuit Breaker Configuration
*/
readonly circuitBreaker: pulumi.Output<outputs.apimanagement.BackendCircuitBreakerResponse | undefined>;
/**
* Backend Credentials Contract Properties
*/
readonly credentials: pulumi.Output<outputs.apimanagement.BackendCredentialsContractResponse | undefined>;
/**
* Backend Description.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
readonly pool: pulumi.Output<outputs.apimanagement.BackendBaseParametersResponsePool | undefined>;
/**
* Backend Properties contract
*/
readonly properties: pulumi.Output<outputs.apimanagement.BackendPropertiesResponse>;
/**
* Backend communication protocol.
*/
readonly protocol: pulumi.Output<string>;
/**
* Backend gateway Contract Properties
*/
readonly proxy: pulumi.Output<outputs.apimanagement.BackendProxyContractResponse | undefined>;
/**
* Management Uri of the Resource in External System. This URL can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.
*/
readonly resourceId: pulumi.Output<string | undefined>;
/**
* Backend Title.
*/
readonly title: pulumi.Output<string | undefined>;
/**
* Backend TLS Properties
*/
readonly tls: pulumi.Output<outputs.apimanagement.BackendTlsPropertiesResponse | undefined>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Runtime Url of the Backend.
*/
readonly url: pulumi.Output<string>;
/**
* Create a WorkspaceBackend 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: WorkspaceBackendArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a WorkspaceBackend resource.
*/
export interface WorkspaceBackendArgs {
/**
* Identifier of the Backend entity. Must be unique in the current API Management service instance.
*/
backendId?: pulumi.Input<string>;
/**
* Backend Circuit Breaker Configuration
*/
circuitBreaker?: pulumi.Input<inputs.apimanagement.BackendCircuitBreakerArgs>;
/**
* Backend Credentials Contract Properties
*/
credentials?: pulumi.Input<inputs.apimanagement.BackendCredentialsContractArgs>;
/**
* Backend Description.
*/
description?: pulumi.Input<string>;
pool?: pulumi.Input<inputs.apimanagement.BackendBaseParametersPoolArgs>;
/**
* Backend Properties contract
*/
properties?: pulumi.Input<inputs.apimanagement.BackendPropertiesArgs>;
/**
* Backend communication protocol.
*/
protocol: pulumi.Input<string | enums.apimanagement.BackendProtocol>;
/**
* Backend gateway Contract Properties
*/
proxy?: pulumi.Input<inputs.apimanagement.BackendProxyContractArgs>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Management Uri of the Resource in External System. This URL can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.
*/
resourceId?: pulumi.Input<string>;
/**
* The name of the API Management service.
*/
serviceName: pulumi.Input<string>;
/**
* Backend Title.
*/
title?: pulumi.Input<string>;
/**
* Backend TLS Properties
*/
tls?: pulumi.Input<inputs.apimanagement.BackendTlsPropertiesArgs>;
/**
* Type of the backend. A backend can be either Single or Pool.
*/
type?: pulumi.Input<string | enums.apimanagement.BackendType>;
/**
* Runtime Url of the Backend.
*/
url: pulumi.Input<string>;
/**
* Workspace identifier. Must be unique in the current API Management service instance.
*/
workspaceId: pulumi.Input<string>;
}