@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.3 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets the details of the backend specified by its identifier.
*
* Uses Azure REST API version 2024-06-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 function getWorkspaceBackend(args: GetWorkspaceBackendArgs, opts?: pulumi.InvokeOptions): Promise<GetWorkspaceBackendResult>;
export interface GetWorkspaceBackendArgs {
/**
* Identifier of the Backend entity. Must be unique in the current API Management service instance.
*/
backendId: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
/**
* The name of the API Management service.
*/
serviceName: string;
/**
* Workspace identifier. Must be unique in the current API Management service instance.
*/
workspaceId: string;
}
/**
* Backend details.
*/
export interface GetWorkspaceBackendResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Backend Circuit Breaker Configuration
*/
readonly circuitBreaker?: outputs.apimanagement.BackendCircuitBreakerResponse;
/**
* Backend Credentials Contract Properties
*/
readonly credentials?: outputs.apimanagement.BackendCredentialsContractResponse;
/**
* Backend Description.
*/
readonly description?: string;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* The name of the resource
*/
readonly name: string;
readonly pool?: outputs.apimanagement.BackendBaseParametersResponsePool;
/**
* Backend Properties contract
*/
readonly properties: outputs.apimanagement.BackendPropertiesResponse;
/**
* Backend communication protocol.
*/
readonly protocol: string;
/**
* Backend gateway Contract Properties
*/
readonly proxy?: outputs.apimanagement.BackendProxyContractResponse;
/**
* 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?: string;
/**
* Backend Title.
*/
readonly title?: string;
/**
* Backend TLS Properties
*/
readonly tls?: outputs.apimanagement.BackendTlsPropertiesResponse;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* Runtime Url of the Backend.
*/
readonly url: string;
}
/**
* Gets the details of the backend specified by its identifier.
*
* Uses Azure REST API version 2024-06-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 function getWorkspaceBackendOutput(args: GetWorkspaceBackendOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetWorkspaceBackendResult>;
export interface GetWorkspaceBackendOutputArgs {
/**
* Identifier of the Backend entity. Must be unique in the current API Management service instance.
*/
backendId: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the API Management service.
*/
serviceName: pulumi.Input<string>;
/**
* Workspace identifier. Must be unique in the current API Management service instance.
*/
workspaceId: pulumi.Input<string>;
}