azure-native.apimanagement.WorkspaceBackend
Explore with Pulumi AI
Backend details. Azure REST API version: 2023-09-01-preview.
Other available API versions: 2024-05-01, 2024-06-01-preview.
Example Usage
ApiManagementCreateWorkspaceBackendProxyBackend
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var workspaceBackend = new AzureNative.ApiManagement.WorkspaceBackend("workspaceBackend", new()
{
BackendId = "proxybackend",
Credentials = new AzureNative.ApiManagement.Inputs.BackendCredentialsContractArgs
{
Authorization = new AzureNative.ApiManagement.Inputs.BackendAuthorizationHeaderCredentialsArgs
{
Parameter = "opensesma",
Scheme = "Basic",
},
Header =
{
{ "x-my-1", new[]
{
"val1",
"val2",
} },
},
Query =
{
{ "sv", new[]
{
"xx",
"bb",
"cc",
} },
},
},
Description = "description5308",
Protocol = AzureNative.ApiManagement.BackendProtocol.Http,
Proxy = new AzureNative.ApiManagement.Inputs.BackendProxyContractArgs
{
Password = "<password>",
Url = "http://192.168.1.1:8080",
Username = "Contoso\\admin",
},
ResourceGroupName = "rg1",
ServiceName = "apimService1",
Tls = new AzureNative.ApiManagement.Inputs.BackendTlsPropertiesArgs
{
ValidateCertificateChain = true,
ValidateCertificateName = true,
},
Url = "https://backendname2644/",
WorkspaceId = "wks1",
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apimanagement.NewWorkspaceBackend(ctx, "workspaceBackend", &apimanagement.WorkspaceBackendArgs{
BackendId: pulumi.String("proxybackend"),
Credentials: &apimanagement.BackendCredentialsContractArgs{
Authorization: &apimanagement.BackendAuthorizationHeaderCredentialsArgs{
Parameter: pulumi.String("opensesma"),
Scheme: pulumi.String("Basic"),
},
Header: pulumi.StringArrayMap{
"x-my-1": pulumi.StringArray{
pulumi.String("val1"),
pulumi.String("val2"),
},
},
Query: pulumi.StringArrayMap{
"sv": pulumi.StringArray{
pulumi.String("xx"),
pulumi.String("bb"),
pulumi.String("cc"),
},
},
},
Description: pulumi.String("description5308"),
Protocol: pulumi.String(apimanagement.BackendProtocolHttp),
Proxy: &apimanagement.BackendProxyContractArgs{
Password: pulumi.String("<password>"),
Url: pulumi.String("http://192.168.1.1:8080"),
Username: pulumi.String("Contoso\\admin"),
},
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
Tls: &apimanagement.BackendTlsPropertiesArgs{
ValidateCertificateChain: pulumi.Bool(true),
ValidateCertificateName: pulumi.Bool(true),
},
Url: pulumi.String("https://backendname2644/"),
WorkspaceId: pulumi.String("wks1"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.WorkspaceBackend;
import com.pulumi.azurenative.apimanagement.WorkspaceBackendArgs;
import com.pulumi.azurenative.apimanagement.inputs.BackendCredentialsContractArgs;
import com.pulumi.azurenative.apimanagement.inputs.BackendAuthorizationHeaderCredentialsArgs;
import com.pulumi.azurenative.apimanagement.inputs.BackendProxyContractArgs;
import com.pulumi.azurenative.apimanagement.inputs.BackendTlsPropertiesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var workspaceBackend = new WorkspaceBackend("workspaceBackend", WorkspaceBackendArgs.builder()
.backendId("proxybackend")
.credentials(BackendCredentialsContractArgs.builder()
.authorization(BackendAuthorizationHeaderCredentialsArgs.builder()
.parameter("opensesma")
.scheme("Basic")
.build())
.header(Map.of("x-my-1",
"val1",
"val2"))
.query(Map.of("sv",
"xx",
"bb",
"cc"))
.build())
.description("description5308")
.protocol("http")
.proxy(BackendProxyContractArgs.builder()
.password("<password>")
.url("http://192.168.1.1:8080")
.username("Contoso\\admin")
.build())
.resourceGroupName("rg1")
.serviceName("apimService1")
.tls(BackendTlsPropertiesArgs.builder()
.validateCertificateChain(true)
.validateCertificateName(true)
.build())
.url("https://backendname2644/")
.workspaceId("wks1")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
workspace_backend = azure_native.apimanagement.WorkspaceBackend("workspaceBackend",
backend_id="proxybackend",
credentials={
"authorization": {
"parameter": "opensesma",
"scheme": "Basic",
},
"header": {
"x-my-1": [
"val1",
"val2",
],
},
"query": {
"sv": [
"xx",
"bb",
"cc",
],
},
},
description="description5308",
protocol=azure_native.apimanagement.BackendProtocol.HTTP,
proxy={
"password": "<password>",
"url": "http://192.168.1.1:8080",
"username": "Contoso\\admin",
},
resource_group_name="rg1",
service_name="apimService1",
tls={
"validate_certificate_chain": True,
"validate_certificate_name": True,
},
url="https://backendname2644/",
workspace_id="wks1")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const workspaceBackend = new azure_native.apimanagement.WorkspaceBackend("workspaceBackend", {
backendId: "proxybackend",
credentials: {
authorization: {
parameter: "opensesma",
scheme: "Basic",
},
header: {
"x-my-1": [
"val1",
"val2",
],
},
query: {
sv: [
"xx",
"bb",
"cc",
],
},
},
description: "description5308",
protocol: azure_native.apimanagement.BackendProtocol.Http,
proxy: {
password: "<password>",
url: "http://192.168.1.1:8080",
username: "Contoso\\admin",
},
resourceGroupName: "rg1",
serviceName: "apimService1",
tls: {
validateCertificateChain: true,
validateCertificateName: true,
},
url: "https://backendname2644/",
workspaceId: "wks1",
});
resources:
workspaceBackend:
type: azure-native:apimanagement:WorkspaceBackend
properties:
backendId: proxybackend
credentials:
authorization:
parameter: opensesma
scheme: Basic
header:
x-my-1:
- val1
- val2
query:
sv:
- xx
- bb
- cc
description: description5308
protocol: http
proxy:
password: <password>
url: http://192.168.1.1:8080
username: Contoso\admin
resourceGroupName: rg1
serviceName: apimService1
tls:
validateCertificateChain: true
validateCertificateName: true
url: https://backendname2644/
workspaceId: wks1
ApiManagementCreateWorkspaceBackendServiceFabric
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var workspaceBackend = new AzureNative.ApiManagement.WorkspaceBackend("workspaceBackend", new()
{
BackendId = "sfbackend",
Description = "Service Fabric Test App 1",
Properties = new AzureNative.ApiManagement.Inputs.BackendPropertiesArgs
{
ServiceFabricCluster = new AzureNative.ApiManagement.Inputs.BackendServiceFabricClusterPropertiesArgs
{
ClientCertificateId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1",
ManagementEndpoints = new[]
{
"https://somecluster.com",
},
MaxPartitionResolutionRetries = 5,
ServerX509Names = new[]
{
new AzureNative.ApiManagement.Inputs.X509CertificateNameArgs
{
IssuerCertificateThumbprint = "IssuerCertificateThumbprint1",
Name = "ServerCommonName1",
},
},
},
},
Protocol = AzureNative.ApiManagement.BackendProtocol.Http,
ResourceGroupName = "rg1",
ServiceName = "apimService1",
Url = "fabric:/mytestapp/mytestservice",
WorkspaceId = "wks1",
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apimanagement.NewWorkspaceBackend(ctx, "workspaceBackend", &apimanagement.WorkspaceBackendArgs{
BackendId: pulumi.String("sfbackend"),
Description: pulumi.String("Service Fabric Test App 1"),
Properties: &apimanagement.BackendPropertiesArgs{
ServiceFabricCluster: &apimanagement.BackendServiceFabricClusterPropertiesArgs{
ClientCertificateId: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1"),
ManagementEndpoints: pulumi.StringArray{
pulumi.String("https://somecluster.com"),
},
MaxPartitionResolutionRetries: pulumi.Int(5),
ServerX509Names: apimanagement.X509CertificateNameArray{
&apimanagement.X509CertificateNameArgs{
IssuerCertificateThumbprint: pulumi.String("IssuerCertificateThumbprint1"),
Name: pulumi.String("ServerCommonName1"),
},
},
},
},
Protocol: pulumi.String(apimanagement.BackendProtocolHttp),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
Url: pulumi.String("fabric:/mytestapp/mytestservice"),
WorkspaceId: pulumi.String("wks1"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.WorkspaceBackend;
import com.pulumi.azurenative.apimanagement.WorkspaceBackendArgs;
import com.pulumi.azurenative.apimanagement.inputs.BackendPropertiesArgs;
import com.pulumi.azurenative.apimanagement.inputs.BackendServiceFabricClusterPropertiesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var workspaceBackend = new WorkspaceBackend("workspaceBackend", WorkspaceBackendArgs.builder()
.backendId("sfbackend")
.description("Service Fabric Test App 1")
.properties(BackendPropertiesArgs.builder()
.serviceFabricCluster(BackendServiceFabricClusterPropertiesArgs.builder()
.clientCertificateId("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1")
.managementEndpoints("https://somecluster.com")
.maxPartitionResolutionRetries(5)
.serverX509Names(X509CertificateNameArgs.builder()
.issuerCertificateThumbprint("IssuerCertificateThumbprint1")
.name("ServerCommonName1")
.build())
.build())
.build())
.protocol("http")
.resourceGroupName("rg1")
.serviceName("apimService1")
.url("fabric:/mytestapp/mytestservice")
.workspaceId("wks1")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
workspace_backend = azure_native.apimanagement.WorkspaceBackend("workspaceBackend",
backend_id="sfbackend",
description="Service Fabric Test App 1",
properties={
"service_fabric_cluster": {
"client_certificate_id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1",
"management_endpoints": ["https://somecluster.com"],
"max_partition_resolution_retries": 5,
"server_x509_names": [{
"issuer_certificate_thumbprint": "IssuerCertificateThumbprint1",
"name": "ServerCommonName1",
}],
},
},
protocol=azure_native.apimanagement.BackendProtocol.HTTP,
resource_group_name="rg1",
service_name="apimService1",
url="fabric:/mytestapp/mytestservice",
workspace_id="wks1")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const workspaceBackend = new azure_native.apimanagement.WorkspaceBackend("workspaceBackend", {
backendId: "sfbackend",
description: "Service Fabric Test App 1",
properties: {
serviceFabricCluster: {
clientCertificateId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1",
managementEndpoints: ["https://somecluster.com"],
maxPartitionResolutionRetries: 5,
serverX509Names: [{
issuerCertificateThumbprint: "IssuerCertificateThumbprint1",
name: "ServerCommonName1",
}],
},
},
protocol: azure_native.apimanagement.BackendProtocol.Http,
resourceGroupName: "rg1",
serviceName: "apimService1",
url: "fabric:/mytestapp/mytestservice",
workspaceId: "wks1",
});
resources:
workspaceBackend:
type: azure-native:apimanagement:WorkspaceBackend
properties:
backendId: sfbackend
description: Service Fabric Test App 1
properties:
serviceFabricCluster:
clientCertificateId: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1
managementEndpoints:
- https://somecluster.com
maxPartitionResolutionRetries: 5
serverX509Names:
- issuerCertificateThumbprint: IssuerCertificateThumbprint1
name: ServerCommonName1
protocol: http
resourceGroupName: rg1
serviceName: apimService1
url: fabric:/mytestapp/mytestservice
workspaceId: wks1
Create WorkspaceBackend Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WorkspaceBackend(name: string, args: WorkspaceBackendArgs, opts?: CustomResourceOptions);
@overload
def WorkspaceBackend(resource_name: str,
args: WorkspaceBackendArgs,
opts: Optional[ResourceOptions] = None)
@overload
def WorkspaceBackend(resource_name: str,
opts: Optional[ResourceOptions] = None,
protocol: Optional[Union[str, BackendProtocol]] = None,
workspace_id: Optional[str] = None,
url: Optional[str] = None,
service_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
pool: Optional[BackendBaseParametersPoolArgs] = None,
properties: Optional[BackendPropertiesArgs] = None,
proxy: Optional[BackendProxyContractArgs] = None,
backend_id: Optional[str] = None,
resource_id: Optional[str] = None,
description: Optional[str] = None,
title: Optional[str] = None,
tls: Optional[BackendTlsPropertiesArgs] = None,
type: Optional[Union[str, BackendType]] = None,
credentials: Optional[BackendCredentialsContractArgs] = None,
circuit_breaker: Optional[BackendCircuitBreakerArgs] = None)
func NewWorkspaceBackend(ctx *Context, name string, args WorkspaceBackendArgs, opts ...ResourceOption) (*WorkspaceBackend, error)
public WorkspaceBackend(string name, WorkspaceBackendArgs args, CustomResourceOptions? opts = null)
public WorkspaceBackend(String name, WorkspaceBackendArgs args)
public WorkspaceBackend(String name, WorkspaceBackendArgs args, CustomResourceOptions options)
type: azure-native:apimanagement:WorkspaceBackend
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args WorkspaceBackendArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args WorkspaceBackendArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args WorkspaceBackendArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WorkspaceBackendArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WorkspaceBackendArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var workspaceBackendResource = new AzureNative.ApiManagement.WorkspaceBackend("workspaceBackendResource", new()
{
Protocol = "string",
WorkspaceId = "string",
Url = "string",
ServiceName = "string",
ResourceGroupName = "string",
Pool = new AzureNative.ApiManagement.Inputs.BackendBaseParametersPoolArgs
{
Services = new[]
{
new AzureNative.ApiManagement.Inputs.BackendPoolItemArgs
{
Id = "string",
Priority = 0,
Weight = 0,
},
},
},
Properties = new AzureNative.ApiManagement.Inputs.BackendPropertiesArgs
{
ServiceFabricCluster = new AzureNative.ApiManagement.Inputs.BackendServiceFabricClusterPropertiesArgs
{
ManagementEndpoints = new[]
{
"string",
},
ClientCertificateId = "string",
ClientCertificatethumbprint = "string",
MaxPartitionResolutionRetries = 0,
ServerCertificateThumbprints = new[]
{
"string",
},
ServerX509Names = new[]
{
new AzureNative.ApiManagement.Inputs.X509CertificateNameArgs
{
IssuerCertificateThumbprint = "string",
Name = "string",
},
},
},
},
Proxy = new AzureNative.ApiManagement.Inputs.BackendProxyContractArgs
{
Url = "string",
Password = "string",
Username = "string",
},
BackendId = "string",
ResourceId = "string",
Description = "string",
Title = "string",
Tls = new AzureNative.ApiManagement.Inputs.BackendTlsPropertiesArgs
{
ValidateCertificateChain = false,
ValidateCertificateName = false,
},
Type = "string",
Credentials = new AzureNative.ApiManagement.Inputs.BackendCredentialsContractArgs
{
Authorization = new AzureNative.ApiManagement.Inputs.BackendAuthorizationHeaderCredentialsArgs
{
Parameter = "string",
Scheme = "string",
},
Certificate = new[]
{
"string",
},
CertificateIds = new[]
{
"string",
},
Header =
{
{ "string", new[]
{
"string",
} },
},
Query =
{
{ "string", new[]
{
"string",
} },
},
},
CircuitBreaker = new AzureNative.ApiManagement.Inputs.BackendCircuitBreakerArgs
{
Rules = new[]
{
new AzureNative.ApiManagement.Inputs.CircuitBreakerRuleArgs
{
AcceptRetryAfter = false,
FailureCondition = new AzureNative.ApiManagement.Inputs.CircuitBreakerFailureConditionArgs
{
Count = 0,
ErrorReasons = new[]
{
"string",
},
Interval = "string",
Percentage = 0,
StatusCodeRanges = new[]
{
new AzureNative.ApiManagement.Inputs.FailureStatusCodeRangeArgs
{
Max = 0,
Min = 0,
},
},
},
Name = "string",
TripDuration = "string",
},
},
},
});
example, err := apimanagement.NewWorkspaceBackend(ctx, "workspaceBackendResource", &apimanagement.WorkspaceBackendArgs{
Protocol: pulumi.String("string"),
WorkspaceId: pulumi.String("string"),
Url: pulumi.String("string"),
ServiceName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
Pool: &apimanagement.BackendBaseParametersPoolArgs{
Services: apimanagement.BackendPoolItemArray{
&apimanagement.BackendPoolItemArgs{
Id: pulumi.String("string"),
Priority: pulumi.Int(0),
Weight: pulumi.Int(0),
},
},
},
Properties: &apimanagement.BackendPropertiesArgs{
ServiceFabricCluster: &apimanagement.BackendServiceFabricClusterPropertiesArgs{
ManagementEndpoints: pulumi.StringArray{
pulumi.String("string"),
},
ClientCertificateId: pulumi.String("string"),
ClientCertificatethumbprint: pulumi.String("string"),
MaxPartitionResolutionRetries: pulumi.Int(0),
ServerCertificateThumbprints: pulumi.StringArray{
pulumi.String("string"),
},
ServerX509Names: apimanagement.X509CertificateNameArray{
&apimanagement.X509CertificateNameArgs{
IssuerCertificateThumbprint: pulumi.String("string"),
Name: pulumi.String("string"),
},
},
},
},
Proxy: &apimanagement.BackendProxyContractArgs{
Url: pulumi.String("string"),
Password: pulumi.String("string"),
Username: pulumi.String("string"),
},
BackendId: pulumi.String("string"),
ResourceId: pulumi.String("string"),
Description: pulumi.String("string"),
Title: pulumi.String("string"),
Tls: &apimanagement.BackendTlsPropertiesArgs{
ValidateCertificateChain: pulumi.Bool(false),
ValidateCertificateName: pulumi.Bool(false),
},
Type: pulumi.String("string"),
Credentials: &apimanagement.BackendCredentialsContractArgs{
Authorization: &apimanagement.BackendAuthorizationHeaderCredentialsArgs{
Parameter: pulumi.String("string"),
Scheme: pulumi.String("string"),
},
Certificate: pulumi.StringArray{
pulumi.String("string"),
},
CertificateIds: pulumi.StringArray{
pulumi.String("string"),
},
Header: pulumi.StringArrayMap{
"string": pulumi.StringArray{
pulumi.String("string"),
},
},
Query: pulumi.StringArrayMap{
"string": pulumi.StringArray{
pulumi.String("string"),
},
},
},
CircuitBreaker: &apimanagement.BackendCircuitBreakerArgs{
Rules: apimanagement.CircuitBreakerRuleArray{
&apimanagement.CircuitBreakerRuleArgs{
AcceptRetryAfter: pulumi.Bool(false),
FailureCondition: &apimanagement.CircuitBreakerFailureConditionArgs{
Count: pulumi.Float64(0),
ErrorReasons: pulumi.StringArray{
pulumi.String("string"),
},
Interval: pulumi.String("string"),
Percentage: pulumi.Float64(0),
StatusCodeRanges: apimanagement.FailureStatusCodeRangeArray{
&apimanagement.FailureStatusCodeRangeArgs{
Max: pulumi.Int(0),
Min: pulumi.Int(0),
},
},
},
Name: pulumi.String("string"),
TripDuration: pulumi.String("string"),
},
},
},
})
var workspaceBackendResource = new WorkspaceBackend("workspaceBackendResource", WorkspaceBackendArgs.builder()
.protocol("string")
.workspaceId("string")
.url("string")
.serviceName("string")
.resourceGroupName("string")
.pool(BackendBaseParametersPoolArgs.builder()
.services(BackendPoolItemArgs.builder()
.id("string")
.priority(0)
.weight(0)
.build())
.build())
.properties(BackendPropertiesArgs.builder()
.serviceFabricCluster(BackendServiceFabricClusterPropertiesArgs.builder()
.managementEndpoints("string")
.clientCertificateId("string")
.clientCertificatethumbprint("string")
.maxPartitionResolutionRetries(0)
.serverCertificateThumbprints("string")
.serverX509Names(X509CertificateNameArgs.builder()
.issuerCertificateThumbprint("string")
.name("string")
.build())
.build())
.build())
.proxy(BackendProxyContractArgs.builder()
.url("string")
.password("string")
.username("string")
.build())
.backendId("string")
.resourceId("string")
.description("string")
.title("string")
.tls(BackendTlsPropertiesArgs.builder()
.validateCertificateChain(false)
.validateCertificateName(false)
.build())
.type("string")
.credentials(BackendCredentialsContractArgs.builder()
.authorization(BackendAuthorizationHeaderCredentialsArgs.builder()
.parameter("string")
.scheme("string")
.build())
.certificate("string")
.certificateIds("string")
.header(Map.of("string", "string"))
.query(Map.of("string", "string"))
.build())
.circuitBreaker(BackendCircuitBreakerArgs.builder()
.rules(CircuitBreakerRuleArgs.builder()
.acceptRetryAfter(false)
.failureCondition(CircuitBreakerFailureConditionArgs.builder()
.count(0)
.errorReasons("string")
.interval("string")
.percentage(0)
.statusCodeRanges(FailureStatusCodeRangeArgs.builder()
.max(0)
.min(0)
.build())
.build())
.name("string")
.tripDuration("string")
.build())
.build())
.build());
workspace_backend_resource = azure_native.apimanagement.WorkspaceBackend("workspaceBackendResource",
protocol="string",
workspace_id="string",
url="string",
service_name="string",
resource_group_name="string",
pool={
"services": [{
"id": "string",
"priority": 0,
"weight": 0,
}],
},
properties={
"service_fabric_cluster": {
"management_endpoints": ["string"],
"client_certificate_id": "string",
"client_certificatethumbprint": "string",
"max_partition_resolution_retries": 0,
"server_certificate_thumbprints": ["string"],
"server_x509_names": [{
"issuer_certificate_thumbprint": "string",
"name": "string",
}],
},
},
proxy={
"url": "string",
"password": "string",
"username": "string",
},
backend_id="string",
resource_id="string",
description="string",
title="string",
tls={
"validate_certificate_chain": False,
"validate_certificate_name": False,
},
type="string",
credentials={
"authorization": {
"parameter": "string",
"scheme": "string",
},
"certificate": ["string"],
"certificate_ids": ["string"],
"header": {
"string": ["string"],
},
"query": {
"string": ["string"],
},
},
circuit_breaker={
"rules": [{
"accept_retry_after": False,
"failure_condition": {
"count": 0,
"error_reasons": ["string"],
"interval": "string",
"percentage": 0,
"status_code_ranges": [{
"max": 0,
"min": 0,
}],
},
"name": "string",
"trip_duration": "string",
}],
})
const workspaceBackendResource = new azure_native.apimanagement.WorkspaceBackend("workspaceBackendResource", {
protocol: "string",
workspaceId: "string",
url: "string",
serviceName: "string",
resourceGroupName: "string",
pool: {
services: [{
id: "string",
priority: 0,
weight: 0,
}],
},
properties: {
serviceFabricCluster: {
managementEndpoints: ["string"],
clientCertificateId: "string",
clientCertificatethumbprint: "string",
maxPartitionResolutionRetries: 0,
serverCertificateThumbprints: ["string"],
serverX509Names: [{
issuerCertificateThumbprint: "string",
name: "string",
}],
},
},
proxy: {
url: "string",
password: "string",
username: "string",
},
backendId: "string",
resourceId: "string",
description: "string",
title: "string",
tls: {
validateCertificateChain: false,
validateCertificateName: false,
},
type: "string",
credentials: {
authorization: {
parameter: "string",
scheme: "string",
},
certificate: ["string"],
certificateIds: ["string"],
header: {
string: ["string"],
},
query: {
string: ["string"],
},
},
circuitBreaker: {
rules: [{
acceptRetryAfter: false,
failureCondition: {
count: 0,
errorReasons: ["string"],
interval: "string",
percentage: 0,
statusCodeRanges: [{
max: 0,
min: 0,
}],
},
name: "string",
tripDuration: "string",
}],
},
});
type: azure-native:apimanagement:WorkspaceBackend
properties:
backendId: string
circuitBreaker:
rules:
- acceptRetryAfter: false
failureCondition:
count: 0
errorReasons:
- string
interval: string
percentage: 0
statusCodeRanges:
- max: 0
min: 0
name: string
tripDuration: string
credentials:
authorization:
parameter: string
scheme: string
certificate:
- string
certificateIds:
- string
header:
string:
- string
query:
string:
- string
description: string
pool:
services:
- id: string
priority: 0
weight: 0
properties:
serviceFabricCluster:
clientCertificateId: string
clientCertificatethumbprint: string
managementEndpoints:
- string
maxPartitionResolutionRetries: 0
serverCertificateThumbprints:
- string
serverX509Names:
- issuerCertificateThumbprint: string
name: string
protocol: string
proxy:
password: string
url: string
username: string
resourceGroupName: string
resourceId: string
serviceName: string
title: string
tls:
validateCertificateChain: false
validateCertificateName: false
type: string
url: string
workspaceId: string
WorkspaceBackend Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The WorkspaceBackend resource accepts the following input properties:
- Protocol
string | Pulumi.
Azure Native. Api Management. Backend Protocol - Backend communication protocol.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Url string
- Runtime Url of the Backend.
- Workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
- Backend
Id string - Identifier of the Backend entity. Must be unique in the current API Management service instance.
- Circuit
Breaker Pulumi.Azure Native. Api Management. Inputs. Backend Circuit Breaker - Backend Circuit Breaker Configuration
- Credentials
Pulumi.
Azure Native. Api Management. Inputs. Backend Credentials Contract - Backend Credentials Contract Properties
- Description string
- Backend Description.
- Pool
Pulumi.
Azure Native. Api Management. Inputs. Backend Base Parameters Pool - Properties
Pulumi.
Azure Native. Api Management. Inputs. Backend Properties - Backend Properties contract
- Proxy
Pulumi.
Azure Native. Api Management. Inputs. Backend Proxy Contract - Backend gateway Contract Properties
- Resource
Id 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.
- Title string
- Backend Title.
- Tls
Pulumi.
Azure Native. Api Management. Inputs. Backend Tls Properties - Backend TLS Properties
- Type
string | Pulumi.
Azure Native. Api Management. Backend Type - Type of the backend. A backend can be either Single or Pool.
- Protocol
string | Backend
Protocol - Backend communication protocol.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Url string
- Runtime Url of the Backend.
- Workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
- Backend
Id string - Identifier of the Backend entity. Must be unique in the current API Management service instance.
- Circuit
Breaker BackendCircuit Breaker Args - Backend Circuit Breaker Configuration
- Credentials
Backend
Credentials Contract Args - Backend Credentials Contract Properties
- Description string
- Backend Description.
- Pool
Backend
Base Parameters Pool Args - Properties
Backend
Properties Args - Backend Properties contract
- Proxy
Backend
Proxy Contract Args - Backend gateway Contract Properties
- Resource
Id 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.
- Title string
- Backend Title.
- Tls
Backend
Tls Properties Args - Backend TLS Properties
- Type
string | Backend
Type - Type of the backend. A backend can be either Single or Pool.
- protocol
String | Backend
Protocol - Backend communication protocol.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- url String
- Runtime Url of the Backend.
- workspace
Id String - Workspace identifier. Must be unique in the current API Management service instance.
- backend
Id String - Identifier of the Backend entity. Must be unique in the current API Management service instance.
- circuit
Breaker BackendCircuit Breaker - Backend Circuit Breaker Configuration
- credentials
Backend
Credentials Contract - Backend Credentials Contract Properties
- description String
- Backend Description.
- pool
Backend
Base Parameters Pool - properties
Backend
Properties - Backend Properties contract
- proxy
Backend
Proxy Contract - Backend gateway Contract Properties
- resource
Id 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.
- title String
- Backend Title.
- tls
Backend
Tls Properties - Backend TLS Properties
- type
String | Backend
Type - Type of the backend. A backend can be either Single or Pool.
- protocol
string | Backend
Protocol - Backend communication protocol.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- url string
- Runtime Url of the Backend.
- workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
- backend
Id string - Identifier of the Backend entity. Must be unique in the current API Management service instance.
- circuit
Breaker BackendCircuit Breaker - Backend Circuit Breaker Configuration
- credentials
Backend
Credentials Contract - Backend Credentials Contract Properties
- description string
- Backend Description.
- pool
Backend
Base Parameters Pool - properties
Backend
Properties - Backend Properties contract
- proxy
Backend
Proxy Contract - Backend gateway Contract Properties
- resource
Id 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.
- title string
- Backend Title.
- tls
Backend
Tls Properties - Backend TLS Properties
- type
string | Backend
Type - Type of the backend. A backend can be either Single or Pool.
- protocol
str | Backend
Protocol - Backend communication protocol.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- service_
name str - The name of the API Management service.
- url str
- Runtime Url of the Backend.
- workspace_
id str - Workspace identifier. Must be unique in the current API Management service instance.
- backend_
id str - Identifier of the Backend entity. Must be unique in the current API Management service instance.
- circuit_
breaker BackendCircuit Breaker Args - Backend Circuit Breaker Configuration
- credentials
Backend
Credentials Contract Args - Backend Credentials Contract Properties
- description str
- Backend Description.
- pool
Backend
Base Parameters Pool Args - properties
Backend
Properties Args - Backend Properties contract
- proxy
Backend
Proxy Contract Args - Backend gateway Contract Properties
- resource_
id str - Management Uri of the Resource in External System. This URL can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.
- title str
- Backend Title.
- tls
Backend
Tls Properties Args - Backend TLS Properties
- type
str | Backend
Type - Type of the backend. A backend can be either Single or Pool.
- protocol String | "http" | "soap"
- Backend communication protocol.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- url String
- Runtime Url of the Backend.
- workspace
Id String - Workspace identifier. Must be unique in the current API Management service instance.
- backend
Id String - Identifier of the Backend entity. Must be unique in the current API Management service instance.
- circuit
Breaker Property Map - Backend Circuit Breaker Configuration
- credentials Property Map
- Backend Credentials Contract Properties
- description String
- Backend Description.
- pool Property Map
- properties Property Map
- Backend Properties contract
- proxy Property Map
- Backend gateway Contract Properties
- resource
Id 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.
- title String
- Backend Title.
- tls Property Map
- Backend TLS Properties
- type String | "Single" | "Pool"
- Type of the backend. A backend can be either Single or Pool.
Outputs
All input properties are implicitly available as output properties. Additionally, the WorkspaceBackend resource produces the following output properties:
Supporting Types
BackendAuthorizationHeaderCredentials, BackendAuthorizationHeaderCredentialsArgs
BackendAuthorizationHeaderCredentialsResponse, BackendAuthorizationHeaderCredentialsResponseArgs
BackendBaseParametersPool, BackendBaseParametersPoolArgs
- Services
List<Pulumi.
Azure Native. Api Management. Inputs. Backend Pool Item> - The list of backend entities belonging to a pool.
- Services
[]Backend
Pool Item - The list of backend entities belonging to a pool.
- services
List<Backend
Pool Item> - The list of backend entities belonging to a pool.
- services
Backend
Pool Item[] - The list of backend entities belonging to a pool.
- services
Sequence[Backend
Pool Item] - The list of backend entities belonging to a pool.
- services List<Property Map>
- The list of backend entities belonging to a pool.
BackendBaseParametersResponsePool, BackendBaseParametersResponsePoolArgs
- Services
List<Pulumi.
Azure Native. Api Management. Inputs. Backend Pool Item Response> - The list of backend entities belonging to a pool.
- Services
[]Backend
Pool Item Response - The list of backend entities belonging to a pool.
- services
List<Backend
Pool Item Response> - The list of backend entities belonging to a pool.
- services
Backend
Pool Item Response[] - The list of backend entities belonging to a pool.
- services
Sequence[Backend
Pool Item Response] - The list of backend entities belonging to a pool.
- services List<Property Map>
- The list of backend entities belonging to a pool.
BackendCircuitBreaker, BackendCircuitBreakerArgs
- Rules
List<Pulumi.
Azure Native. Api Management. Inputs. Circuit Breaker Rule> - The rules for tripping the backend.
- Rules
[]Circuit
Breaker Rule - The rules for tripping the backend.
- rules
List<Circuit
Breaker Rule> - The rules for tripping the backend.
- rules
Circuit
Breaker Rule[] - The rules for tripping the backend.
- rules
Sequence[Circuit
Breaker Rule] - The rules for tripping the backend.
- rules List<Property Map>
- The rules for tripping the backend.
BackendCircuitBreakerResponse, BackendCircuitBreakerResponseArgs
- Rules
List<Pulumi.
Azure Native. Api Management. Inputs. Circuit Breaker Rule Response> - The rules for tripping the backend.
- Rules
[]Circuit
Breaker Rule Response - The rules for tripping the backend.
- rules
List<Circuit
Breaker Rule Response> - The rules for tripping the backend.
- rules
Circuit
Breaker Rule Response[] - The rules for tripping the backend.
- rules
Sequence[Circuit
Breaker Rule Response] - The rules for tripping the backend.
- rules List<Property Map>
- The rules for tripping the backend.
BackendCredentialsContract, BackendCredentialsContractArgs
- Pulumi.
Azure Native. Api Management. Inputs. Backend Authorization Header Credentials - Authorization header authentication
- Certificate List<string>
- List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
- Certificate
Ids List<string> - List of Client Certificate Ids.
- Header
Dictionary<string, Immutable
Array<string>> - Header Parameter description.
- Query
Dictionary<string, Immutable
Array<string>> - Query Parameter description.
- Backend
Authorization Header Credentials - Authorization header authentication
- Certificate []string
- List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
- Certificate
Ids []string - List of Client Certificate Ids.
- Header map[string][]string
- Header Parameter description.
- Query map[string][]string
- Query Parameter description.
- Backend
Authorization Header Credentials - Authorization header authentication
- certificate List<String>
- List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
- certificate
Ids List<String> - List of Client Certificate Ids.
- header Map<String,List<String>>
- Header Parameter description.
- query Map<String,List<String>>
- Query Parameter description.
- Backend
Authorization Header Credentials - Authorization header authentication
- certificate string[]
- List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
- certificate
Ids string[] - List of Client Certificate Ids.
- header {[key: string]: string[]}
- Header Parameter description.
- query {[key: string]: string[]}
- Query Parameter description.
- Backend
Authorization Header Credentials - Authorization header authentication
- certificate Sequence[str]
- List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
- certificate_
ids Sequence[str] - List of Client Certificate Ids.
- header Mapping[str, Sequence[str]]
- Header Parameter description.
- query Mapping[str, Sequence[str]]
- Query Parameter description.
- Property Map
- Authorization header authentication
- certificate List<String>
- List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
- certificate
Ids List<String> - List of Client Certificate Ids.
- header Map<List<String>>
- Header Parameter description.
- query Map<List<String>>
- Query Parameter description.
BackendCredentialsContractResponse, BackendCredentialsContractResponseArgs
- Pulumi.
Azure Native. Api Management. Inputs. Backend Authorization Header Credentials Response - Authorization header authentication
- Certificate List<string>
- List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
- Certificate
Ids List<string> - List of Client Certificate Ids.
- Header
Dictionary<string, Immutable
Array<string>> - Header Parameter description.
- Query
Dictionary<string, Immutable
Array<string>> - Query Parameter description.
- Backend
Authorization Header Credentials Response - Authorization header authentication
- Certificate []string
- List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
- Certificate
Ids []string - List of Client Certificate Ids.
- Header map[string][]string
- Header Parameter description.
- Query map[string][]string
- Query Parameter description.
- Backend
Authorization Header Credentials Response - Authorization header authentication
- certificate List<String>
- List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
- certificate
Ids List<String> - List of Client Certificate Ids.
- header Map<String,List<String>>
- Header Parameter description.
- query Map<String,List<String>>
- Query Parameter description.
- Backend
Authorization Header Credentials Response - Authorization header authentication
- certificate string[]
- List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
- certificate
Ids string[] - List of Client Certificate Ids.
- header {[key: string]: string[]}
- Header Parameter description.
- query {[key: string]: string[]}
- Query Parameter description.
- Backend
Authorization Header Credentials Response - Authorization header authentication
- certificate Sequence[str]
- List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
- certificate_
ids Sequence[str] - List of Client Certificate Ids.
- header Mapping[str, Sequence[str]]
- Header Parameter description.
- query Mapping[str, Sequence[str]]
- Query Parameter description.
- Property Map
- Authorization header authentication
- certificate List<String>
- List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
- certificate
Ids List<String> - List of Client Certificate Ids.
- header Map<List<String>>
- Header Parameter description.
- query Map<List<String>>
- Query Parameter description.
BackendPoolItem, BackendPoolItemArgs
- Id string
- The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity.
- Priority int
- The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- Weight int
- The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- Id string
- The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity.
- Priority int
- The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- Weight int
- The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- id String
- The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity.
- priority Integer
- The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- weight Integer
- The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- id string
- The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity.
- priority number
- The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- weight number
- The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- id str
- The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity.
- priority int
- The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- weight int
- The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- id String
- The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity.
- priority Number
- The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- weight Number
- The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
BackendPoolItemResponse, BackendPoolItemResponseArgs
- Id string
- The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity.
- Priority int
- The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- Weight int
- The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- Id string
- The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity.
- Priority int
- The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- Weight int
- The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- id String
- The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity.
- priority Integer
- The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- weight Integer
- The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- id string
- The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity.
- priority number
- The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- weight number
- The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- id str
- The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity.
- priority int
- The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- weight int
- The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- id String
- The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity.
- priority Number
- The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
- weight Number
- The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified.
BackendProperties, BackendPropertiesArgs
- Service
Fabric Pulumi.Cluster Azure Native. Api Management. Inputs. Backend Service Fabric Cluster Properties - Backend Service Fabric Cluster Properties
- Service
Fabric BackendCluster Service Fabric Cluster Properties - Backend Service Fabric Cluster Properties
- service
Fabric BackendCluster Service Fabric Cluster Properties - Backend Service Fabric Cluster Properties
- service
Fabric BackendCluster Service Fabric Cluster Properties - Backend Service Fabric Cluster Properties
- service_
fabric_ Backendcluster Service Fabric Cluster Properties - Backend Service Fabric Cluster Properties
- service
Fabric Property MapCluster - Backend Service Fabric Cluster Properties
BackendPropertiesResponse, BackendPropertiesResponseArgs
- Service
Fabric Pulumi.Cluster Azure Native. Api Management. Inputs. Backend Service Fabric Cluster Properties Response - Backend Service Fabric Cluster Properties
- Service
Fabric BackendCluster Service Fabric Cluster Properties Response - Backend Service Fabric Cluster Properties
- service
Fabric BackendCluster Service Fabric Cluster Properties Response - Backend Service Fabric Cluster Properties
- service
Fabric BackendCluster Service Fabric Cluster Properties Response - Backend Service Fabric Cluster Properties
- service_
fabric_ Backendcluster Service Fabric Cluster Properties Response - Backend Service Fabric Cluster Properties
- service
Fabric Property MapCluster - Backend Service Fabric Cluster Properties
BackendProtocol, BackendProtocolArgs
- Http
- httpThe Backend is a RESTful service.
- Soap
- soapThe Backend is a SOAP service.
- Backend
Protocol Http - httpThe Backend is a RESTful service.
- Backend
Protocol Soap - soapThe Backend is a SOAP service.
- Http
- httpThe Backend is a RESTful service.
- Soap
- soapThe Backend is a SOAP service.
- Http
- httpThe Backend is a RESTful service.
- Soap
- soapThe Backend is a SOAP service.
- HTTP
- httpThe Backend is a RESTful service.
- SOAP
- soapThe Backend is a SOAP service.
- "http"
- httpThe Backend is a RESTful service.
- "soap"
- soapThe Backend is a SOAP service.
BackendProxyContract, BackendProxyContractArgs
BackendProxyContractResponse, BackendProxyContractResponseArgs
BackendServiceFabricClusterProperties, BackendServiceFabricClusterPropertiesArgs
- Management
Endpoints List<string> - The cluster management endpoint.
- Client
Certificate stringId - The client certificate id for the management endpoint.
- Client
Certificatethumbprint string - The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
- Max
Partition intResolution Retries - Maximum number of retries while attempting resolve the partition.
- Server
Certificate List<string>Thumbprints - Thumbprints of certificates cluster management service uses for tls communication
- Server
X509Names List<Pulumi.Azure Native. Api Management. Inputs. X509Certificate Name> - Server X509 Certificate Names Collection
- Management
Endpoints []string - The cluster management endpoint.
- Client
Certificate stringId - The client certificate id for the management endpoint.
- Client
Certificatethumbprint string - The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
- Max
Partition intResolution Retries - Maximum number of retries while attempting resolve the partition.
- Server
Certificate []stringThumbprints - Thumbprints of certificates cluster management service uses for tls communication
- Server
X509Names []X509CertificateName - Server X509 Certificate Names Collection
- management
Endpoints List<String> - The cluster management endpoint.
- client
Certificate StringId - The client certificate id for the management endpoint.
- client
Certificatethumbprint String - The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
- max
Partition IntegerResolution Retries - Maximum number of retries while attempting resolve the partition.
- server
Certificate List<String>Thumbprints - Thumbprints of certificates cluster management service uses for tls communication
- server
X509Names List<X509CertificateName> - Server X509 Certificate Names Collection
- management
Endpoints string[] - The cluster management endpoint.
- client
Certificate stringId - The client certificate id for the management endpoint.
- client
Certificatethumbprint string - The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
- max
Partition numberResolution Retries - Maximum number of retries while attempting resolve the partition.
- server
Certificate string[]Thumbprints - Thumbprints of certificates cluster management service uses for tls communication
- server
X509Names X509CertificateName[] - Server X509 Certificate Names Collection
- management_
endpoints Sequence[str] - The cluster management endpoint.
- client_
certificate_ strid - The client certificate id for the management endpoint.
- client_
certificatethumbprint str - The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
- max_
partition_ intresolution_ retries - Maximum number of retries while attempting resolve the partition.
- server_
certificate_ Sequence[str]thumbprints - Thumbprints of certificates cluster management service uses for tls communication
- server_
x509_ Sequence[X509Certificatenames Name] - Server X509 Certificate Names Collection
- management
Endpoints List<String> - The cluster management endpoint.
- client
Certificate StringId - The client certificate id for the management endpoint.
- client
Certificatethumbprint String - The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
- max
Partition NumberResolution Retries - Maximum number of retries while attempting resolve the partition.
- server
Certificate List<String>Thumbprints - Thumbprints of certificates cluster management service uses for tls communication
- server
X509Names List<Property Map> - Server X509 Certificate Names Collection
BackendServiceFabricClusterPropertiesResponse, BackendServiceFabricClusterPropertiesResponseArgs
- Management
Endpoints List<string> - The cluster management endpoint.
- Client
Certificate stringId - The client certificate id for the management endpoint.
- Client
Certificatethumbprint string - The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
- Max
Partition intResolution Retries - Maximum number of retries while attempting resolve the partition.
- Server
Certificate List<string>Thumbprints - Thumbprints of certificates cluster management service uses for tls communication
- Server
X509Names List<Pulumi.Azure Native. Api Management. Inputs. X509Certificate Name Response> - Server X509 Certificate Names Collection
- Management
Endpoints []string - The cluster management endpoint.
- Client
Certificate stringId - The client certificate id for the management endpoint.
- Client
Certificatethumbprint string - The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
- Max
Partition intResolution Retries - Maximum number of retries while attempting resolve the partition.
- Server
Certificate []stringThumbprints - Thumbprints of certificates cluster management service uses for tls communication
- Server
X509Names []X509CertificateName Response - Server X509 Certificate Names Collection
- management
Endpoints List<String> - The cluster management endpoint.
- client
Certificate StringId - The client certificate id for the management endpoint.
- client
Certificatethumbprint String - The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
- max
Partition IntegerResolution Retries - Maximum number of retries while attempting resolve the partition.
- server
Certificate List<String>Thumbprints - Thumbprints of certificates cluster management service uses for tls communication
- server
X509Names List<X509CertificateName Response> - Server X509 Certificate Names Collection
- management
Endpoints string[] - The cluster management endpoint.
- client
Certificate stringId - The client certificate id for the management endpoint.
- client
Certificatethumbprint string - The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
- max
Partition numberResolution Retries - Maximum number of retries while attempting resolve the partition.
- server
Certificate string[]Thumbprints - Thumbprints of certificates cluster management service uses for tls communication
- server
X509Names X509CertificateName Response[] - Server X509 Certificate Names Collection
- management_
endpoints Sequence[str] - The cluster management endpoint.
- client_
certificate_ strid - The client certificate id for the management endpoint.
- client_
certificatethumbprint str - The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
- max_
partition_ intresolution_ retries - Maximum number of retries while attempting resolve the partition.
- server_
certificate_ Sequence[str]thumbprints - Thumbprints of certificates cluster management service uses for tls communication
- server_
x509_ Sequence[X509Certificatenames Name Response] - Server X509 Certificate Names Collection
- management
Endpoints List<String> - The cluster management endpoint.
- client
Certificate StringId - The client certificate id for the management endpoint.
- client
Certificatethumbprint String - The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided
- max
Partition NumberResolution Retries - Maximum number of retries while attempting resolve the partition.
- server
Certificate List<String>Thumbprints - Thumbprints of certificates cluster management service uses for tls communication
- server
X509Names List<Property Map> - Server X509 Certificate Names Collection
BackendTlsProperties, BackendTlsPropertiesArgs
- Validate
Certificate boolChain - Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
- Validate
Certificate boolName - Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
- Validate
Certificate boolChain - Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
- Validate
Certificate boolName - Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
- validate
Certificate BooleanChain - Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
- validate
Certificate BooleanName - Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
- validate
Certificate booleanChain - Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
- validate
Certificate booleanName - Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
- validate_
certificate_ boolchain - Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
- validate_
certificate_ boolname - Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
- validate
Certificate BooleanChain - Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
- validate
Certificate BooleanName - Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
BackendTlsPropertiesResponse, BackendTlsPropertiesResponseArgs
- Validate
Certificate boolChain - Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
- Validate
Certificate boolName - Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
- Validate
Certificate boolChain - Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
- Validate
Certificate boolName - Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
- validate
Certificate BooleanChain - Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
- validate
Certificate BooleanName - Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
- validate
Certificate booleanChain - Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
- validate
Certificate booleanName - Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
- validate_
certificate_ boolchain - Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
- validate_
certificate_ boolname - Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
- validate
Certificate BooleanChain - Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
- validate
Certificate BooleanName - Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.
BackendType, BackendTypeArgs
- Single
- Singlesupports single backend
- Pool
- Poolsupports pool backend
- Backend
Type Single - Singlesupports single backend
- Backend
Type Pool - Poolsupports pool backend
- Single
- Singlesupports single backend
- Pool
- Poolsupports pool backend
- Single
- Singlesupports single backend
- Pool
- Poolsupports pool backend
- SINGLE
- Singlesupports single backend
- POOL
- Poolsupports pool backend
- "Single"
- Singlesupports single backend
- "Pool"
- Poolsupports pool backend
CircuitBreakerFailureCondition, CircuitBreakerFailureConditionArgs
- Count double
- The threshold for opening the circuit.
- Error
Reasons List<string> - The error reasons which are considered as failure.
- Interval string
- The interval during which the failures are counted.
- Percentage double
- The threshold for opening the circuit.
- Status
Code List<Pulumi.Ranges Azure Native. Api Management. Inputs. Failure Status Code Range> - The status code ranges which are considered as failure.
- Count float64
- The threshold for opening the circuit.
- Error
Reasons []string - The error reasons which are considered as failure.
- Interval string
- The interval during which the failures are counted.
- Percentage float64
- The threshold for opening the circuit.
- Status
Code []FailureRanges Status Code Range - The status code ranges which are considered as failure.
- count Double
- The threshold for opening the circuit.
- error
Reasons List<String> - The error reasons which are considered as failure.
- interval String
- The interval during which the failures are counted.
- percentage Double
- The threshold for opening the circuit.
- status
Code List<FailureRanges Status Code Range> - The status code ranges which are considered as failure.
- count number
- The threshold for opening the circuit.
- error
Reasons string[] - The error reasons which are considered as failure.
- interval string
- The interval during which the failures are counted.
- percentage number
- The threshold for opening the circuit.
- status
Code FailureRanges Status Code Range[] - The status code ranges which are considered as failure.
- count float
- The threshold for opening the circuit.
- error_
reasons Sequence[str] - The error reasons which are considered as failure.
- interval str
- The interval during which the failures are counted.
- percentage float
- The threshold for opening the circuit.
- status_
code_ Sequence[Failureranges Status Code Range] - The status code ranges which are considered as failure.
- count Number
- The threshold for opening the circuit.
- error
Reasons List<String> - The error reasons which are considered as failure.
- interval String
- The interval during which the failures are counted.
- percentage Number
- The threshold for opening the circuit.
- status
Code List<Property Map>Ranges - The status code ranges which are considered as failure.
CircuitBreakerFailureConditionResponse, CircuitBreakerFailureConditionResponseArgs
- Count double
- The threshold for opening the circuit.
- Error
Reasons List<string> - The error reasons which are considered as failure.
- Interval string
- The interval during which the failures are counted.
- Percentage double
- The threshold for opening the circuit.
- Status
Code List<Pulumi.Ranges Azure Native. Api Management. Inputs. Failure Status Code Range Response> - The status code ranges which are considered as failure.
- Count float64
- The threshold for opening the circuit.
- Error
Reasons []string - The error reasons which are considered as failure.
- Interval string
- The interval during which the failures are counted.
- Percentage float64
- The threshold for opening the circuit.
- Status
Code []FailureRanges Status Code Range Response - The status code ranges which are considered as failure.
- count Double
- The threshold for opening the circuit.
- error
Reasons List<String> - The error reasons which are considered as failure.
- interval String
- The interval during which the failures are counted.
- percentage Double
- The threshold for opening the circuit.
- status
Code List<FailureRanges Status Code Range Response> - The status code ranges which are considered as failure.
- count number
- The threshold for opening the circuit.
- error
Reasons string[] - The error reasons which are considered as failure.
- interval string
- The interval during which the failures are counted.
- percentage number
- The threshold for opening the circuit.
- status
Code FailureRanges Status Code Range Response[] - The status code ranges which are considered as failure.
- count float
- The threshold for opening the circuit.
- error_
reasons Sequence[str] - The error reasons which are considered as failure.
- interval str
- The interval during which the failures are counted.
- percentage float
- The threshold for opening the circuit.
- status_
code_ Sequence[Failureranges Status Code Range Response] - The status code ranges which are considered as failure.
- count Number
- The threshold for opening the circuit.
- error
Reasons List<String> - The error reasons which are considered as failure.
- interval String
- The interval during which the failures are counted.
- percentage Number
- The threshold for opening the circuit.
- status
Code List<Property Map>Ranges - The status code ranges which are considered as failure.
CircuitBreakerRule, CircuitBreakerRuleArgs
- Accept
Retry boolAfter - flag to accept Retry-After header from the backend.
- Failure
Condition Pulumi.Azure Native. Api Management. Inputs. Circuit Breaker Failure Condition - The conditions for tripping the circuit breaker.
- Name string
- The rule name.
- Trip
Duration string - The duration for which the circuit will be tripped.
- Accept
Retry boolAfter - flag to accept Retry-After header from the backend.
- Failure
Condition CircuitBreaker Failure Condition - The conditions for tripping the circuit breaker.
- Name string
- The rule name.
- Trip
Duration string - The duration for which the circuit will be tripped.
- accept
Retry BooleanAfter - flag to accept Retry-After header from the backend.
- failure
Condition CircuitBreaker Failure Condition - The conditions for tripping the circuit breaker.
- name String
- The rule name.
- trip
Duration String - The duration for which the circuit will be tripped.
- accept
Retry booleanAfter - flag to accept Retry-After header from the backend.
- failure
Condition CircuitBreaker Failure Condition - The conditions for tripping the circuit breaker.
- name string
- The rule name.
- trip
Duration string - The duration for which the circuit will be tripped.
- accept_
retry_ boolafter - flag to accept Retry-After header from the backend.
- failure_
condition CircuitBreaker Failure Condition - The conditions for tripping the circuit breaker.
- name str
- The rule name.
- trip_
duration str - The duration for which the circuit will be tripped.
- accept
Retry BooleanAfter - flag to accept Retry-After header from the backend.
- failure
Condition Property Map - The conditions for tripping the circuit breaker.
- name String
- The rule name.
- trip
Duration String - The duration for which the circuit will be tripped.
CircuitBreakerRuleResponse, CircuitBreakerRuleResponseArgs
- Accept
Retry boolAfter - flag to accept Retry-After header from the backend.
- Failure
Condition Pulumi.Azure Native. Api Management. Inputs. Circuit Breaker Failure Condition Response - The conditions for tripping the circuit breaker.
- Name string
- The rule name.
- Trip
Duration string - The duration for which the circuit will be tripped.
- Accept
Retry boolAfter - flag to accept Retry-After header from the backend.
- Failure
Condition CircuitBreaker Failure Condition Response - The conditions for tripping the circuit breaker.
- Name string
- The rule name.
- Trip
Duration string - The duration for which the circuit will be tripped.
- accept
Retry BooleanAfter - flag to accept Retry-After header from the backend.
- failure
Condition CircuitBreaker Failure Condition Response - The conditions for tripping the circuit breaker.
- name String
- The rule name.
- trip
Duration String - The duration for which the circuit will be tripped.
- accept
Retry booleanAfter - flag to accept Retry-After header from the backend.
- failure
Condition CircuitBreaker Failure Condition Response - The conditions for tripping the circuit breaker.
- name string
- The rule name.
- trip
Duration string - The duration for which the circuit will be tripped.
- accept_
retry_ boolafter - flag to accept Retry-After header from the backend.
- failure_
condition CircuitBreaker Failure Condition Response - The conditions for tripping the circuit breaker.
- name str
- The rule name.
- trip_
duration str - The duration for which the circuit will be tripped.
- accept
Retry BooleanAfter - flag to accept Retry-After header from the backend.
- failure
Condition Property Map - The conditions for tripping the circuit breaker.
- name String
- The rule name.
- trip
Duration String - The duration for which the circuit will be tripped.
FailureStatusCodeRange, FailureStatusCodeRangeArgs
FailureStatusCodeRangeResponse, FailureStatusCodeRangeResponseArgs
X509CertificateName, X509CertificateNameArgs
- Issuer
Certificate stringThumbprint - Thumbprint for the Issuer of the Certificate.
- Name string
- Common Name of the Certificate.
- Issuer
Certificate stringThumbprint - Thumbprint for the Issuer of the Certificate.
- Name string
- Common Name of the Certificate.
- issuer
Certificate StringThumbprint - Thumbprint for the Issuer of the Certificate.
- name String
- Common Name of the Certificate.
- issuer
Certificate stringThumbprint - Thumbprint for the Issuer of the Certificate.
- name string
- Common Name of the Certificate.
- issuer_
certificate_ strthumbprint - Thumbprint for the Issuer of the Certificate.
- name str
- Common Name of the Certificate.
- issuer
Certificate StringThumbprint - Thumbprint for the Issuer of the Certificate.
- name String
- Common Name of the Certificate.
X509CertificateNameResponse, X509CertificateNameResponseArgs
- Issuer
Certificate stringThumbprint - Thumbprint for the Issuer of the Certificate.
- Name string
- Common Name of the Certificate.
- Issuer
Certificate stringThumbprint - Thumbprint for the Issuer of the Certificate.
- Name string
- Common Name of the Certificate.
- issuer
Certificate StringThumbprint - Thumbprint for the Issuer of the Certificate.
- name String
- Common Name of the Certificate.
- issuer
Certificate stringThumbprint - Thumbprint for the Issuer of the Certificate.
- name string
- Common Name of the Certificate.
- issuer_
certificate_ strthumbprint - Thumbprint for the Issuer of the Certificate.
- name str
- Common Name of the Certificate.
- issuer
Certificate StringThumbprint - Thumbprint for the Issuer of the Certificate.
- name String
- Common Name of the Certificate.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:apimanagement:WorkspaceBackend sfbackend /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/backends/{backendId}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0