Docs Home
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
azure-native.apimanagement.Api
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
API details. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.
Other available API versions: 2016-10-10, 2017-03-01, 2018-06-01-preview, 2020-12-01, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.
Example Usage
ApiManagementCreateApi
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var api = new AzureNative.ApiManagement.Api("api", new()
{
ApiId = "tempgroup",
AuthenticationSettings = new AzureNative.ApiManagement.Inputs.AuthenticationSettingsContractArgs
{
OAuth2 = new AzureNative.ApiManagement.Inputs.OAuth2AuthenticationSettingsContractArgs
{
AuthorizationServerId = "authorizationServerId2283",
Scope = "oauth2scope2580",
},
},
Description = "apidescription5200",
DisplayName = "apiname1463",
Path = "newapiPath",
Protocols = new[]
{
AzureNative.ApiManagement.Protocol.Https,
AzureNative.ApiManagement.Protocol.Http,
},
ResourceGroupName = "rg1",
ServiceName = "apimService1",
ServiceUrl = "http://newechoapi.cloudapp.net/api",
SubscriptionKeyParameterNames = new AzureNative.ApiManagement.Inputs.SubscriptionKeyParameterNamesContractArgs
{
Header = "header4520",
Query = "query3037",
},
});
});
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.NewApi(ctx, "api", &apimanagement.ApiArgs{
ApiId: pulumi.String("tempgroup"),
AuthenticationSettings: &apimanagement.AuthenticationSettingsContractArgs{
OAuth2: &apimanagement.OAuth2AuthenticationSettingsContractArgs{
AuthorizationServerId: pulumi.String("authorizationServerId2283"),
Scope: pulumi.String("oauth2scope2580"),
},
},
Description: pulumi.String("apidescription5200"),
DisplayName: pulumi.String("apiname1463"),
Path: pulumi.String("newapiPath"),
Protocols: pulumi.StringArray{
pulumi.String(apimanagement.ProtocolHttps),
pulumi.String(apimanagement.ProtocolHttp),
},
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
ServiceUrl: pulumi.String("http://newechoapi.cloudapp.net/api"),
SubscriptionKeyParameterNames: &apimanagement.SubscriptionKeyParameterNamesContractArgs{
Header: pulumi.String("header4520"),
Query: pulumi.String("query3037"),
},
})
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.Api;
import com.pulumi.azurenative.apimanagement.ApiArgs;
import com.pulumi.azurenative.apimanagement.inputs.AuthenticationSettingsContractArgs;
import com.pulumi.azurenative.apimanagement.inputs.OAuth2AuthenticationSettingsContractArgs;
import com.pulumi.azurenative.apimanagement.inputs.SubscriptionKeyParameterNamesContractArgs;
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 api = new Api("api", ApiArgs.builder()
.apiId("tempgroup")
.authenticationSettings(AuthenticationSettingsContractArgs.builder()
.oAuth2(OAuth2AuthenticationSettingsContractArgs.builder()
.authorizationServerId("authorizationServerId2283")
.scope("oauth2scope2580")
.build())
.build())
.description("apidescription5200")
.displayName("apiname1463")
.path("newapiPath")
.protocols(
"https",
"http")
.resourceGroupName("rg1")
.serviceName("apimService1")
.serviceUrl("http://newechoapi.cloudapp.net/api")
.subscriptionKeyParameterNames(SubscriptionKeyParameterNamesContractArgs.builder()
.header("header4520")
.query("query3037")
.build())
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const api = new azure_native.apimanagement.Api("api", {
apiId: "tempgroup",
authenticationSettings: {
oAuth2: {
authorizationServerId: "authorizationServerId2283",
scope: "oauth2scope2580",
},
},
description: "apidescription5200",
displayName: "apiname1463",
path: "newapiPath",
protocols: [
azure_native.apimanagement.Protocol.Https,
azure_native.apimanagement.Protocol.Http,
],
resourceGroupName: "rg1",
serviceName: "apimService1",
serviceUrl: "http://newechoapi.cloudapp.net/api",
subscriptionKeyParameterNames: {
header: "header4520",
query: "query3037",
},
});
import pulumi
import pulumi_azure_native as azure_native
api = azure_native.apimanagement.Api("api",
api_id="tempgroup",
authentication_settings={
"o_auth2": {
"authorization_server_id": "authorizationServerId2283",
"scope": "oauth2scope2580",
},
},
description="apidescription5200",
display_name="apiname1463",
path="newapiPath",
protocols=[
azure_native.apimanagement.Protocol.HTTPS,
azure_native.apimanagement.Protocol.HTTP,
],
resource_group_name="rg1",
service_name="apimService1",
service_url="http://newechoapi.cloudapp.net/api",
subscription_key_parameter_names={
"header": "header4520",
"query": "query3037",
})
resources:
api:
type: azure-native:apimanagement:Api
properties:
apiId: tempgroup
authenticationSettings:
oAuth2:
authorizationServerId: authorizationServerId2283
scope: oauth2scope2580
description: apidescription5200
displayName: apiname1463
path: newapiPath
protocols:
- https
- http
resourceGroupName: rg1
serviceName: apimService1
serviceUrl: http://newechoapi.cloudapp.net/api
subscriptionKeyParameterNames:
header: header4520
query: query3037
ApiManagementCreateApiClone
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var api = new AzureNative.ApiManagement.Api("api", new()
{
ApiId = "echo-api2",
Description = "Copy of Existing Echo Api including Operations.",
DisplayName = "Echo API2",
IsCurrent = true,
Path = "echo2",
Protocols = new[]
{
AzureNative.ApiManagement.Protocol.Http,
AzureNative.ApiManagement.Protocol.Https,
},
ResourceGroupName = "rg1",
ServiceName = "apimService1",
ServiceUrl = "http://echoapi.cloudapp.net/api",
SourceApiId = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58a4aeac497000007d040001",
SubscriptionRequired = true,
});
});
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.NewApi(ctx, "api", &apimanagement.ApiArgs{
ApiId: pulumi.String("echo-api2"),
Description: pulumi.String("Copy of Existing Echo Api including Operations."),
DisplayName: pulumi.String("Echo API2"),
IsCurrent: pulumi.Bool(true),
Path: pulumi.String("echo2"),
Protocols: pulumi.StringArray{
pulumi.String(apimanagement.ProtocolHttp),
pulumi.String(apimanagement.ProtocolHttps),
},
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
ServiceUrl: pulumi.String("http://echoapi.cloudapp.net/api"),
SourceApiId: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58a4aeac497000007d040001"),
SubscriptionRequired: pulumi.Bool(true),
})
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.Api;
import com.pulumi.azurenative.apimanagement.ApiArgs;
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 api = new Api("api", ApiArgs.builder()
.apiId("echo-api2")
.description("Copy of Existing Echo Api including Operations.")
.displayName("Echo API2")
.isCurrent(true)
.path("echo2")
.protocols(
"http",
"https")
.resourceGroupName("rg1")
.serviceName("apimService1")
.serviceUrl("http://echoapi.cloudapp.net/api")
.sourceApiId("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58a4aeac497000007d040001")
.subscriptionRequired(true)
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const api = new azure_native.apimanagement.Api("api", {
apiId: "echo-api2",
description: "Copy of Existing Echo Api including Operations.",
displayName: "Echo API2",
isCurrent: true,
path: "echo2",
protocols: [
azure_native.apimanagement.Protocol.Http,
azure_native.apimanagement.Protocol.Https,
],
resourceGroupName: "rg1",
serviceName: "apimService1",
serviceUrl: "http://echoapi.cloudapp.net/api",
sourceApiId: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58a4aeac497000007d040001",
subscriptionRequired: true,
});
import pulumi
import pulumi_azure_native as azure_native
api = azure_native.apimanagement.Api("api",
api_id="echo-api2",
description="Copy of Existing Echo Api including Operations.",
display_name="Echo API2",
is_current=True,
path="echo2",
protocols=[
azure_native.apimanagement.Protocol.HTTP,
azure_native.apimanagement.Protocol.HTTPS,
],
resource_group_name="rg1",
service_name="apimService1",
service_url="http://echoapi.cloudapp.net/api",
source_api_id="/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58a4aeac497000007d040001",
subscription_required=True)
resources:
api:
type: azure-native:apimanagement:Api
properties:
apiId: echo-api2
description: Copy of Existing Echo Api including Operations.
displayName: Echo API2
isCurrent: true
path: echo2
protocols:
- http
- https
resourceGroupName: rg1
serviceName: apimService1
serviceUrl: http://echoapi.cloudapp.net/api
sourceApiId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/58a4aeac497000007d040001
subscriptionRequired: true
ApiManagementCreateApiNewVersionUsingExistingApi
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var api = new AzureNative.ApiManagement.Api("api", new()
{
ApiId = "echoapiv3",
ApiVersion = "v4",
ApiVersionSetId = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458",
Description = "Create Echo API into a new Version using Existing Version Set and Copy all Operations.",
DisplayName = "Echo API2",
IsCurrent = true,
Path = "echo2",
Protocols = new[]
{
AzureNative.ApiManagement.Protocol.Http,
AzureNative.ApiManagement.Protocol.Https,
},
ResourceGroupName = "rg1",
ServiceName = "apimService1",
ServiceUrl = "http://echoapi.cloudapp.net/api",
SourceApiId = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoPath",
SubscriptionRequired = true,
});
});
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.NewApi(ctx, "api", &apimanagement.ApiArgs{
ApiId: pulumi.String("echoapiv3"),
ApiVersion: pulumi.String("v4"),
ApiVersionSetId: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458"),
Description: pulumi.String("Create Echo API into a new Version using Existing Version Set and Copy all Operations."),
DisplayName: pulumi.String("Echo API2"),
IsCurrent: pulumi.Bool(true),
Path: pulumi.String("echo2"),
Protocols: pulumi.StringArray{
pulumi.String(apimanagement.ProtocolHttp),
pulumi.String(apimanagement.ProtocolHttps),
},
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
ServiceUrl: pulumi.String("http://echoapi.cloudapp.net/api"),
SourceApiId: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoPath"),
SubscriptionRequired: pulumi.Bool(true),
})
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.Api;
import com.pulumi.azurenative.apimanagement.ApiArgs;
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 api = new Api("api", ApiArgs.builder()
.apiId("echoapiv3")
.apiVersion("v4")
.apiVersionSetId("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458")
.description("Create Echo API into a new Version using Existing Version Set and Copy all Operations.")
.displayName("Echo API2")
.isCurrent(true)
.path("echo2")
.protocols(
"http",
"https")
.resourceGroupName("rg1")
.serviceName("apimService1")
.serviceUrl("http://echoapi.cloudapp.net/api")
.sourceApiId("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoPath")
.subscriptionRequired(true)
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const api = new azure_native.apimanagement.Api("api", {
apiId: "echoapiv3",
apiVersion: "v4",
apiVersionSetId: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458",
description: "Create Echo API into a new Version using Existing Version Set and Copy all Operations.",
displayName: "Echo API2",
isCurrent: true,
path: "echo2",
protocols: [
azure_native.apimanagement.Protocol.Http,
azure_native.apimanagement.Protocol.Https,
],
resourceGroupName: "rg1",
serviceName: "apimService1",
serviceUrl: "http://echoapi.cloudapp.net/api",
sourceApiId: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoPath",
subscriptionRequired: true,
});
import pulumi
import pulumi_azure_native as azure_native
api = azure_native.apimanagement.Api("api",
api_id="echoapiv3",
api_version="v4",
api_version_set_id="/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458",
description="Create Echo API into a new Version using Existing Version Set and Copy all Operations.",
display_name="Echo API2",
is_current=True,
path="echo2",
protocols=[
azure_native.apimanagement.Protocol.HTTP,
azure_native.apimanagement.Protocol.HTTPS,
],
resource_group_name="rg1",
service_name="apimService1",
service_url="http://echoapi.cloudapp.net/api",
source_api_id="/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoPath",
subscription_required=True)
resources:
api:
type: azure-native:apimanagement:Api
properties:
apiId: echoapiv3
apiVersion: v4
apiVersionSetId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/aa9c59e6-c0cd-4258-9356-9ca7d2f0b458
description: Create Echo API into a new Version using Existing Version Set and Copy all Operations.
displayName: Echo API2
isCurrent: true
path: echo2
protocols:
- http
- https
resourceGroupName: rg1
serviceName: apimService1
serviceUrl: http://echoapi.cloudapp.net/api
sourceApiId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echoPath
subscriptionRequired: true
ApiManagementCreateApiRevisionFromExistingApi
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var api = new AzureNative.ApiManagement.Api("api", new()
{
ApiId = "echo-api;rev=3",
ApiRevisionDescription = "Creating a Revision of an existing API",
Path = "echo",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
ServiceUrl = "http://echoapi.cloudapp.net/apiv3",
SourceApiId = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api",
});
});
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.NewApi(ctx, "api", &apimanagement.ApiArgs{
ApiId: pulumi.String("echo-api;rev=3"),
ApiRevisionDescription: pulumi.String("Creating a Revision of an existing API"),
Path: pulumi.String("echo"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
ServiceUrl: pulumi.String("http://echoapi.cloudapp.net/apiv3"),
SourceApiId: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api"),
})
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.Api;
import com.pulumi.azurenative.apimanagement.ApiArgs;
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 api = new Api("api", ApiArgs.builder()
.apiId("echo-api;rev=3")
.apiRevisionDescription("Creating a Revision of an existing API")
.path("echo")
.resourceGroupName("rg1")
.serviceName("apimService1")
.serviceUrl("http://echoapi.cloudapp.net/apiv3")
.sourceApiId("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const api = new azure_native.apimanagement.Api("api", {
apiId: "echo-api;rev=3",
apiRevisionDescription: "Creating a Revision of an existing API",
path: "echo",
resourceGroupName: "rg1",
serviceName: "apimService1",
serviceUrl: "http://echoapi.cloudapp.net/apiv3",
sourceApiId: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api",
});
import pulumi
import pulumi_azure_native as azure_native
api = azure_native.apimanagement.Api("api",
api_id="echo-api;rev=3",
api_revision_description="Creating a Revision of an existing API",
path="echo",
resource_group_name="rg1",
service_name="apimService1",
service_url="http://echoapi.cloudapp.net/apiv3",
source_api_id="/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api")
resources:
api:
type: azure-native:apimanagement:Api
properties:
apiId: echo-api;rev=3
apiRevisionDescription: Creating a Revision of an existing API
path: echo
resourceGroupName: rg1
serviceName: apimService1
serviceUrl: http://echoapi.cloudapp.net/apiv3
sourceApiId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api
ApiManagementCreateApiUsingImportOverrideServiceUrl
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var api = new AzureNative.ApiManagement.Api("api", new()
{
ApiId = "apidocs",
Format = "swagger-link",
Path = "petstoreapi123",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
ServiceUrl = "http://petstore.swagger.wordnik.com/api",
Value = "http://apimpimportviaurl.azurewebsites.net/api/apidocs/",
});
});
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.NewApi(ctx, "api", &apimanagement.ApiArgs{
ApiId: pulumi.String("apidocs"),
Format: pulumi.String("swagger-link"),
Path: pulumi.String("petstoreapi123"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
ServiceUrl: pulumi.String("http://petstore.swagger.wordnik.com/api"),
Value: pulumi.String("http://apimpimportviaurl.azurewebsites.net/api/apidocs/"),
})
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.Api;
import com.pulumi.azurenative.apimanagement.ApiArgs;
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 api = new Api("api", ApiArgs.builder()
.apiId("apidocs")
.format("swagger-link")
.path("petstoreapi123")
.resourceGroupName("rg1")
.serviceName("apimService1")
.serviceUrl("http://petstore.swagger.wordnik.com/api")
.value("http://apimpimportviaurl.azurewebsites.net/api/apidocs/")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const api = new azure_native.apimanagement.Api("api", {
apiId: "apidocs",
format: "swagger-link",
path: "petstoreapi123",
resourceGroupName: "rg1",
serviceName: "apimService1",
serviceUrl: "http://petstore.swagger.wordnik.com/api",
value: "http://apimpimportviaurl.azurewebsites.net/api/apidocs/",
});
import pulumi
import pulumi_azure_native as azure_native
api = azure_native.apimanagement.Api("api",
api_id="apidocs",
format="swagger-link",
path="petstoreapi123",
resource_group_name="rg1",
service_name="apimService1",
service_url="http://petstore.swagger.wordnik.com/api",
value="http://apimpimportviaurl.azurewebsites.net/api/apidocs/")
resources:
api:
type: azure-native:apimanagement:Api
properties:
apiId: apidocs
format: swagger-link
path: petstoreapi123
resourceGroupName: rg1
serviceName: apimService1
serviceUrl: http://petstore.swagger.wordnik.com/api
value: http://apimpimportviaurl.azurewebsites.net/api/apidocs/
ApiManagementCreateApiUsingOai3Import
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var api = new AzureNative.ApiManagement.Api("api", new()
{
ApiId = "petstore",
Format = AzureNative.ApiManagement.ContentFormat.Openapi_link,
Path = "petstore",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
Value = "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml",
});
});
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.NewApi(ctx, "api", &apimanagement.ApiArgs{
ApiId: pulumi.String("petstore"),
Format: pulumi.String(apimanagement.ContentFormat_Openapi_Link),
Path: pulumi.String("petstore"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
Value: pulumi.String("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml"),
})
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.Api;
import com.pulumi.azurenative.apimanagement.ApiArgs;
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 api = new Api("api", ApiArgs.builder()
.apiId("petstore")
.format("openapi-link")
.path("petstore")
.resourceGroupName("rg1")
.serviceName("apimService1")
.value("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const api = new azure_native.apimanagement.Api("api", {
apiId: "petstore",
format: azure_native.apimanagement.ContentFormat.Openapi_link,
path: "petstore",
resourceGroupName: "rg1",
serviceName: "apimService1",
value: "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml",
});
import pulumi
import pulumi_azure_native as azure_native
api = azure_native.apimanagement.Api("api",
api_id="petstore",
format=azure_native.apimanagement.ContentFormat.OPENAPI_LINK,
path="petstore",
resource_group_name="rg1",
service_name="apimService1",
value="https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml")
resources:
api:
type: azure-native:apimanagement:Api
properties:
apiId: petstore
format: openapi-link
path: petstore
resourceGroupName: rg1
serviceName: apimService1
value: https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml
ApiManagementCreateApiUsingOai3ImportWithTranslateRequiredQueryParametersConduct
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var api = new AzureNative.ApiManagement.Api("api", new()
{
ApiId = "petstore",
Format = AzureNative.ApiManagement.ContentFormat.Openapi_link,
Path = "petstore",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
TranslateRequiredQueryParametersConduct = AzureNative.ApiManagement.TranslateRequiredQueryParametersConduct.Template,
Value = "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml",
});
});
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.NewApi(ctx, "api", &apimanagement.ApiArgs{
ApiId: pulumi.String("petstore"),
Format: pulumi.String(apimanagement.ContentFormat_Openapi_Link),
Path: pulumi.String("petstore"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
TranslateRequiredQueryParametersConduct: pulumi.String(apimanagement.TranslateRequiredQueryParametersConductTemplate),
Value: pulumi.String("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml"),
})
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.Api;
import com.pulumi.azurenative.apimanagement.ApiArgs;
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 api = new Api("api", ApiArgs.builder()
.apiId("petstore")
.format("openapi-link")
.path("petstore")
.resourceGroupName("rg1")
.serviceName("apimService1")
.translateRequiredQueryParametersConduct("template")
.value("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const api = new azure_native.apimanagement.Api("api", {
apiId: "petstore",
format: azure_native.apimanagement.ContentFormat.Openapi_link,
path: "petstore",
resourceGroupName: "rg1",
serviceName: "apimService1",
translateRequiredQueryParametersConduct: azure_native.apimanagement.TranslateRequiredQueryParametersConduct.Template,
value: "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml",
});
import pulumi
import pulumi_azure_native as azure_native
api = azure_native.apimanagement.Api("api",
api_id="petstore",
format=azure_native.apimanagement.ContentFormat.OPENAPI_LINK,
path="petstore",
resource_group_name="rg1",
service_name="apimService1",
translate_required_query_parameters_conduct=azure_native.apimanagement.TranslateRequiredQueryParametersConduct.TEMPLATE,
value="https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml")
resources:
api:
type: azure-native:apimanagement:Api
properties:
apiId: petstore
format: openapi-link
path: petstore
resourceGroupName: rg1
serviceName: apimService1
translateRequiredQueryParametersConduct: template
value: https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml
ApiManagementCreateApiUsingSwaggerImport
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var api = new AzureNative.ApiManagement.Api("api", new()
{
ApiId = "petstore",
Format = AzureNative.ApiManagement.ContentFormat.Swagger_link_json,
Path = "petstore",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
Value = "http://petstore.swagger.io/v2/swagger.json",
});
});
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.NewApi(ctx, "api", &apimanagement.ApiArgs{
ApiId: pulumi.String("petstore"),
Format: pulumi.String(apimanagement.ContentFormat_Swagger_Link_Json),
Path: pulumi.String("petstore"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
Value: pulumi.String("http://petstore.swagger.io/v2/swagger.json"),
})
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.Api;
import com.pulumi.azurenative.apimanagement.ApiArgs;
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 api = new Api("api", ApiArgs.builder()
.apiId("petstore")
.format("swagger-link-json")
.path("petstore")
.resourceGroupName("rg1")
.serviceName("apimService1")
.value("http://petstore.swagger.io/v2/swagger.json")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const api = new azure_native.apimanagement.Api("api", {
apiId: "petstore",
format: azure_native.apimanagement.ContentFormat.Swagger_link_json,
path: "petstore",
resourceGroupName: "rg1",
serviceName: "apimService1",
value: "http://petstore.swagger.io/v2/swagger.json",
});
import pulumi
import pulumi_azure_native as azure_native
api = azure_native.apimanagement.Api("api",
api_id="petstore",
format=azure_native.apimanagement.ContentFormat.SWAGGER_LINK_JSON,
path="petstore",
resource_group_name="rg1",
service_name="apimService1",
value="http://petstore.swagger.io/v2/swagger.json")
resources:
api:
type: azure-native:apimanagement:Api
properties:
apiId: petstore
format: swagger-link-json
path: petstore
resourceGroupName: rg1
serviceName: apimService1
value: http://petstore.swagger.io/v2/swagger.json
ApiManagementCreateApiUsingWadlImport
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var api = new AzureNative.ApiManagement.Api("api", new()
{
ApiId = "petstore",
Format = AzureNative.ApiManagement.ContentFormat.Wadl_link_json,
Path = "collector",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
Value = "https://developer.cisco.com/media/wae-release-6-2-api-reference/wae-collector-rest-api/application.wadl",
});
});
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.NewApi(ctx, "api", &apimanagement.ApiArgs{
ApiId: pulumi.String("petstore"),
Format: pulumi.String(apimanagement.ContentFormat_Wadl_Link_Json),
Path: pulumi.String("collector"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
Value: pulumi.String("https://developer.cisco.com/media/wae-release-6-2-api-reference/wae-collector-rest-api/application.wadl"),
})
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.Api;
import com.pulumi.azurenative.apimanagement.ApiArgs;
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 api = new Api("api", ApiArgs.builder()
.apiId("petstore")
.format("wadl-link-json")
.path("collector")
.resourceGroupName("rg1")
.serviceName("apimService1")
.value("https://developer.cisco.com/media/wae-release-6-2-api-reference/wae-collector-rest-api/application.wadl")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const api = new azure_native.apimanagement.Api("api", {
apiId: "petstore",
format: azure_native.apimanagement.ContentFormat.Wadl_link_json,
path: "collector",
resourceGroupName: "rg1",
serviceName: "apimService1",
value: "https://developer.cisco.com/media/wae-release-6-2-api-reference/wae-collector-rest-api/application.wadl",
});
import pulumi
import pulumi_azure_native as azure_native
api = azure_native.apimanagement.Api("api",
api_id="petstore",
format=azure_native.apimanagement.ContentFormat.WADL_LINK_JSON,
path="collector",
resource_group_name="rg1",
service_name="apimService1",
value="https://developer.cisco.com/media/wae-release-6-2-api-reference/wae-collector-rest-api/application.wadl")
resources:
api:
type: azure-native:apimanagement:Api
properties:
apiId: petstore
format: wadl-link-json
path: collector
resourceGroupName: rg1
serviceName: apimService1
value: https://developer.cisco.com/media/wae-release-6-2-api-reference/wae-collector-rest-api/application.wadl
ApiManagementCreateApiWithMultipleAuthServers
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var api = new AzureNative.ApiManagement.Api("api", new()
{
ApiId = "tempgroup",
AuthenticationSettings = new AzureNative.ApiManagement.Inputs.AuthenticationSettingsContractArgs
{
OAuth2AuthenticationSettings = new[]
{
new AzureNative.ApiManagement.Inputs.OAuth2AuthenticationSettingsContractArgs
{
AuthorizationServerId = "authorizationServerId2283",
Scope = "oauth2scope2580",
},
new AzureNative.ApiManagement.Inputs.OAuth2AuthenticationSettingsContractArgs
{
AuthorizationServerId = "authorizationServerId2284",
Scope = "oauth2scope2581",
},
},
},
Description = "apidescription5200",
DisplayName = "apiname1463",
Path = "newapiPath",
Protocols = new[]
{
AzureNative.ApiManagement.Protocol.Https,
AzureNative.ApiManagement.Protocol.Http,
},
ResourceGroupName = "rg1",
ServiceName = "apimService1",
ServiceUrl = "http://newechoapi.cloudapp.net/api",
SubscriptionKeyParameterNames = new AzureNative.ApiManagement.Inputs.SubscriptionKeyParameterNamesContractArgs
{
Header = "header4520",
Query = "query3037",
},
});
});
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.NewApi(ctx, "api", &apimanagement.ApiArgs{
ApiId: pulumi.String("tempgroup"),
AuthenticationSettings: &apimanagement.AuthenticationSettingsContractArgs{
OAuth2AuthenticationSettings: apimanagement.OAuth2AuthenticationSettingsContractArray{
&apimanagement.OAuth2AuthenticationSettingsContractArgs{
AuthorizationServerId: pulumi.String("authorizationServerId2283"),
Scope: pulumi.String("oauth2scope2580"),
},
&apimanagement.OAuth2AuthenticationSettingsContractArgs{
AuthorizationServerId: pulumi.String("authorizationServerId2284"),
Scope: pulumi.String("oauth2scope2581"),
},
},
},
Description: pulumi.String("apidescription5200"),
DisplayName: pulumi.String("apiname1463"),
Path: pulumi.String("newapiPath"),
Protocols: pulumi.StringArray{
pulumi.String(apimanagement.ProtocolHttps),
pulumi.String(apimanagement.ProtocolHttp),
},
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
ServiceUrl: pulumi.String("http://newechoapi.cloudapp.net/api"),
SubscriptionKeyParameterNames: &apimanagement.SubscriptionKeyParameterNamesContractArgs{
Header: pulumi.String("header4520"),
Query: pulumi.String("query3037"),
},
})
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.Api;
import com.pulumi.azurenative.apimanagement.ApiArgs;
import com.pulumi.azurenative.apimanagement.inputs.AuthenticationSettingsContractArgs;
import com.pulumi.azurenative.apimanagement.inputs.SubscriptionKeyParameterNamesContractArgs;
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 api = new Api("api", ApiArgs.builder()
.apiId("tempgroup")
.authenticationSettings(AuthenticationSettingsContractArgs.builder()
.oAuth2AuthenticationSettings(
OAuth2AuthenticationSettingsContractArgs.builder()
.authorizationServerId("authorizationServerId2283")
.scope("oauth2scope2580")
.build(),
OAuth2AuthenticationSettingsContractArgs.builder()
.authorizationServerId("authorizationServerId2284")
.scope("oauth2scope2581")
.build())
.build())
.description("apidescription5200")
.displayName("apiname1463")
.path("newapiPath")
.protocols(
"https",
"http")
.resourceGroupName("rg1")
.serviceName("apimService1")
.serviceUrl("http://newechoapi.cloudapp.net/api")
.subscriptionKeyParameterNames(SubscriptionKeyParameterNamesContractArgs.builder()
.header("header4520")
.query("query3037")
.build())
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const api = new azure_native.apimanagement.Api("api", {
apiId: "tempgroup",
authenticationSettings: {
oAuth2AuthenticationSettings: [
{
authorizationServerId: "authorizationServerId2283",
scope: "oauth2scope2580",
},
{
authorizationServerId: "authorizationServerId2284",
scope: "oauth2scope2581",
},
],
},
description: "apidescription5200",
displayName: "apiname1463",
path: "newapiPath",
protocols: [
azure_native.apimanagement.Protocol.Https,
azure_native.apimanagement.Protocol.Http,
],
resourceGroupName: "rg1",
serviceName: "apimService1",
serviceUrl: "http://newechoapi.cloudapp.net/api",
subscriptionKeyParameterNames: {
header: "header4520",
query: "query3037",
},
});
import pulumi
import pulumi_azure_native as azure_native
api = azure_native.apimanagement.Api("api",
api_id="tempgroup",
authentication_settings={
"o_auth2_authentication_settings": [
{
"authorization_server_id": "authorizationServerId2283",
"scope": "oauth2scope2580",
},
{
"authorization_server_id": "authorizationServerId2284",
"scope": "oauth2scope2581",
},
],
},
description="apidescription5200",
display_name="apiname1463",
path="newapiPath",
protocols=[
azure_native.apimanagement.Protocol.HTTPS,
azure_native.apimanagement.Protocol.HTTP,
],
resource_group_name="rg1",
service_name="apimService1",
service_url="http://newechoapi.cloudapp.net/api",
subscription_key_parameter_names={
"header": "header4520",
"query": "query3037",
})
resources:
api:
type: azure-native:apimanagement:Api
properties:
apiId: tempgroup
authenticationSettings:
oAuth2AuthenticationSettings:
- authorizationServerId: authorizationServerId2283
scope: oauth2scope2580
- authorizationServerId: authorizationServerId2284
scope: oauth2scope2581
description: apidescription5200
displayName: apiname1463
path: newapiPath
protocols:
- https
- http
resourceGroupName: rg1
serviceName: apimService1
serviceUrl: http://newechoapi.cloudapp.net/api
subscriptionKeyParameterNames:
header: header4520
query: query3037
ApiManagementCreateApiWithMultipleOpenIdConnectProviders
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var api = new AzureNative.ApiManagement.Api("api", new()
{
ApiId = "tempgroup",
AuthenticationSettings = new AzureNative.ApiManagement.Inputs.AuthenticationSettingsContractArgs
{
OpenidAuthenticationSettings = new[]
{
new AzureNative.ApiManagement.Inputs.OpenIdAuthenticationSettingsContractArgs
{
BearerTokenSendingMethods = new[]
{
AzureNative.ApiManagement.BearerTokenSendingMethods.AuthorizationHeader,
},
OpenidProviderId = "openidProviderId2283",
},
new AzureNative.ApiManagement.Inputs.OpenIdAuthenticationSettingsContractArgs
{
BearerTokenSendingMethods = new[]
{
AzureNative.ApiManagement.BearerTokenSendingMethods.AuthorizationHeader,
},
OpenidProviderId = "openidProviderId2284",
},
},
},
Description = "apidescription5200",
DisplayName = "apiname1463",
Path = "newapiPath",
Protocols = new[]
{
AzureNative.ApiManagement.Protocol.Https,
AzureNative.ApiManagement.Protocol.Http,
},
ResourceGroupName = "rg1",
ServiceName = "apimService1",
ServiceUrl = "http://newechoapi.cloudapp.net/api",
SubscriptionKeyParameterNames = new AzureNative.ApiManagement.Inputs.SubscriptionKeyParameterNamesContractArgs
{
Header = "header4520",
Query = "query3037",
},
});
});
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.NewApi(ctx, "api", &apimanagement.ApiArgs{
ApiId: pulumi.String("tempgroup"),
AuthenticationSettings: &apimanagement.AuthenticationSettingsContractArgs{
OpenidAuthenticationSettings: apimanagement.OpenIdAuthenticationSettingsContractArray{
&apimanagement.OpenIdAuthenticationSettingsContractArgs{
BearerTokenSendingMethods: pulumi.StringArray{
pulumi.String(apimanagement.BearerTokenSendingMethodsAuthorizationHeader),
},
OpenidProviderId: pulumi.String("openidProviderId2283"),
},
&apimanagement.OpenIdAuthenticationSettingsContractArgs{
BearerTokenSendingMethods: pulumi.StringArray{
pulumi.String(apimanagement.BearerTokenSendingMethodsAuthorizationHeader),
},
OpenidProviderId: pulumi.String("openidProviderId2284"),
},
},
},
Description: pulumi.String("apidescription5200"),
DisplayName: pulumi.String("apiname1463"),
Path: pulumi.String("newapiPath"),
Protocols: pulumi.StringArray{
pulumi.String(apimanagement.ProtocolHttps),
pulumi.String(apimanagement.ProtocolHttp),
},
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
ServiceUrl: pulumi.String("http://newechoapi.cloudapp.net/api"),
SubscriptionKeyParameterNames: &apimanagement.SubscriptionKeyParameterNamesContractArgs{
Header: pulumi.String("header4520"),
Query: pulumi.String("query3037"),
},
})
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.Api;
import com.pulumi.azurenative.apimanagement.ApiArgs;
import com.pulumi.azurenative.apimanagement.inputs.AuthenticationSettingsContractArgs;
import com.pulumi.azurenative.apimanagement.inputs.SubscriptionKeyParameterNamesContractArgs;
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 api = new Api("api", ApiArgs.builder()
.apiId("tempgroup")
.authenticationSettings(AuthenticationSettingsContractArgs.builder()
.openidAuthenticationSettings(
OpenIdAuthenticationSettingsContractArgs.builder()
.bearerTokenSendingMethods("authorizationHeader")
.openidProviderId("openidProviderId2283")
.build(),
OpenIdAuthenticationSettingsContractArgs.builder()
.bearerTokenSendingMethods("authorizationHeader")
.openidProviderId("openidProviderId2284")
.build())
.build())
.description("apidescription5200")
.displayName("apiname1463")
.path("newapiPath")
.protocols(
"https",
"http")
.resourceGroupName("rg1")
.serviceName("apimService1")
.serviceUrl("http://newechoapi.cloudapp.net/api")
.subscriptionKeyParameterNames(SubscriptionKeyParameterNamesContractArgs.builder()
.header("header4520")
.query("query3037")
.build())
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const api = new azure_native.apimanagement.Api("api", {
apiId: "tempgroup",
authenticationSettings: {
openidAuthenticationSettings: [
{
bearerTokenSendingMethods: [azure_native.apimanagement.BearerTokenSendingMethods.AuthorizationHeader],
openidProviderId: "openidProviderId2283",
},
{
bearerTokenSendingMethods: [azure_native.apimanagement.BearerTokenSendingMethods.AuthorizationHeader],
openidProviderId: "openidProviderId2284",
},
],
},
description: "apidescription5200",
displayName: "apiname1463",
path: "newapiPath",
protocols: [
azure_native.apimanagement.Protocol.Https,
azure_native.apimanagement.Protocol.Http,
],
resourceGroupName: "rg1",
serviceName: "apimService1",
serviceUrl: "http://newechoapi.cloudapp.net/api",
subscriptionKeyParameterNames: {
header: "header4520",
query: "query3037",
},
});
import pulumi
import pulumi_azure_native as azure_native
api = azure_native.apimanagement.Api("api",
api_id="tempgroup",
authentication_settings={
"openid_authentication_settings": [
{
"bearer_token_sending_methods": [azure_native.apimanagement.BearerTokenSendingMethods.AUTHORIZATION_HEADER],
"openid_provider_id": "openidProviderId2283",
},
{
"bearer_token_sending_methods": [azure_native.apimanagement.BearerTokenSendingMethods.AUTHORIZATION_HEADER],
"openid_provider_id": "openidProviderId2284",
},
],
},
description="apidescription5200",
display_name="apiname1463",
path="newapiPath",
protocols=[
azure_native.apimanagement.Protocol.HTTPS,
azure_native.apimanagement.Protocol.HTTP,
],
resource_group_name="rg1",
service_name="apimService1",
service_url="http://newechoapi.cloudapp.net/api",
subscription_key_parameter_names={
"header": "header4520",
"query": "query3037",
})
resources:
api:
type: azure-native:apimanagement:Api
properties:
apiId: tempgroup
authenticationSettings:
openidAuthenticationSettings:
- bearerTokenSendingMethods:
- authorizationHeader
openidProviderId: openidProviderId2283
- bearerTokenSendingMethods:
- authorizationHeader
openidProviderId: openidProviderId2284
description: apidescription5200
displayName: apiname1463
path: newapiPath
protocols:
- https
- http
resourceGroupName: rg1
serviceName: apimService1
serviceUrl: http://newechoapi.cloudapp.net/api
subscriptionKeyParameterNames:
header: header4520
query: query3037
ApiManagementCreateApiWithOpenIdConnect
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var api = new AzureNative.ApiManagement.Api("api", new()
{
ApiId = "tempgroup",
AuthenticationSettings = new AzureNative.ApiManagement.Inputs.AuthenticationSettingsContractArgs
{
Openid = new AzureNative.ApiManagement.Inputs.OpenIdAuthenticationSettingsContractArgs
{
BearerTokenSendingMethods = new[]
{
AzureNative.ApiManagement.BearerTokenSendingMethods.AuthorizationHeader,
},
OpenidProviderId = "testopenid",
},
},
Description = "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.",
DisplayName = "Swagger Petstore",
Path = "petstore",
Protocols = new[]
{
AzureNative.ApiManagement.Protocol.Https,
},
ResourceGroupName = "rg1",
ServiceName = "apimService1",
ServiceUrl = "http://petstore.swagger.io/v2",
SubscriptionKeyParameterNames = new AzureNative.ApiManagement.Inputs.SubscriptionKeyParameterNamesContractArgs
{
Header = "Ocp-Apim-Subscription-Key",
Query = "subscription-key",
},
});
});
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.NewApi(ctx, "api", &apimanagement.ApiArgs{
ApiId: pulumi.String("tempgroup"),
AuthenticationSettings: &apimanagement.AuthenticationSettingsContractArgs{
Openid: &apimanagement.OpenIdAuthenticationSettingsContractArgs{
BearerTokenSendingMethods: pulumi.StringArray{
pulumi.String(apimanagement.BearerTokenSendingMethodsAuthorizationHeader),
},
OpenidProviderId: pulumi.String("testopenid"),
},
},
Description: pulumi.String("This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters."),
DisplayName: pulumi.String("Swagger Petstore"),
Path: pulumi.String("petstore"),
Protocols: pulumi.StringArray{
pulumi.String(apimanagement.ProtocolHttps),
},
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
ServiceUrl: pulumi.String("http://petstore.swagger.io/v2"),
SubscriptionKeyParameterNames: &apimanagement.SubscriptionKeyParameterNamesContractArgs{
Header: pulumi.String("Ocp-Apim-Subscription-Key"),
Query: pulumi.String("subscription-key"),
},
})
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.Api;
import com.pulumi.azurenative.apimanagement.ApiArgs;
import com.pulumi.azurenative.apimanagement.inputs.AuthenticationSettingsContractArgs;
import com.pulumi.azurenative.apimanagement.inputs.OpenIdAuthenticationSettingsContractArgs;
import com.pulumi.azurenative.apimanagement.inputs.SubscriptionKeyParameterNamesContractArgs;
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 api = new Api("api", ApiArgs.builder()
.apiId("tempgroup")
.authenticationSettings(AuthenticationSettingsContractArgs.builder()
.openid(OpenIdAuthenticationSettingsContractArgs.builder()
.bearerTokenSendingMethods("authorizationHeader")
.openidProviderId("testopenid")
.build())
.build())
.description("This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.")
.displayName("Swagger Petstore")
.path("petstore")
.protocols("https")
.resourceGroupName("rg1")
.serviceName("apimService1")
.serviceUrl("http://petstore.swagger.io/v2")
.subscriptionKeyParameterNames(SubscriptionKeyParameterNamesContractArgs.builder()
.header("Ocp-Apim-Subscription-Key")
.query("subscription-key")
.build())
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const api = new azure_native.apimanagement.Api("api", {
apiId: "tempgroup",
authenticationSettings: {
openid: {
bearerTokenSendingMethods: [azure_native.apimanagement.BearerTokenSendingMethods.AuthorizationHeader],
openidProviderId: "testopenid",
},
},
description: "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.",
displayName: "Swagger Petstore",
path: "petstore",
protocols: [azure_native.apimanagement.Protocol.Https],
resourceGroupName: "rg1",
serviceName: "apimService1",
serviceUrl: "http://petstore.swagger.io/v2",
subscriptionKeyParameterNames: {
header: "Ocp-Apim-Subscription-Key",
query: "subscription-key",
},
});
import pulumi
import pulumi_azure_native as azure_native
api = azure_native.apimanagement.Api("api",
api_id="tempgroup",
authentication_settings={
"openid": {
"bearer_token_sending_methods": [azure_native.apimanagement.BearerTokenSendingMethods.AUTHORIZATION_HEADER],
"openid_provider_id": "testopenid",
},
},
description="This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.",
display_name="Swagger Petstore",
path="petstore",
protocols=[azure_native.apimanagement.Protocol.HTTPS],
resource_group_name="rg1",
service_name="apimService1",
service_url="http://petstore.swagger.io/v2",
subscription_key_parameter_names={
"header": "Ocp-Apim-Subscription-Key",
"query": "subscription-key",
})
resources:
api:
type: azure-native:apimanagement:Api
properties:
apiId: tempgroup
authenticationSettings:
openid:
bearerTokenSendingMethods:
- authorizationHeader
openidProviderId: testopenid
description: 'This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.'
displayName: Swagger Petstore
path: petstore
protocols:
- https
resourceGroupName: rg1
serviceName: apimService1
serviceUrl: http://petstore.swagger.io/v2
subscriptionKeyParameterNames:
header: Ocp-Apim-Subscription-Key
query: subscription-key
ApiManagementCreateGraphQLApi
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var api = new AzureNative.ApiManagement.Api("api", new()
{
ApiId = "tempgroup",
ApiType = AzureNative.ApiManagement.ApiType.Graphql,
Description = "apidescription5200",
DisplayName = "apiname1463",
Path = "graphql-api",
Protocols = new[]
{
AzureNative.ApiManagement.Protocol.Http,
AzureNative.ApiManagement.Protocol.Https,
},
ResourceGroupName = "rg1",
ServiceName = "apimService1",
ServiceUrl = "https://api.spacex.land/graphql",
});
});
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.NewApi(ctx, "api", &apimanagement.ApiArgs{
ApiId: pulumi.String("tempgroup"),
ApiType: pulumi.String(apimanagement.ApiTypeGraphql),
Description: pulumi.String("apidescription5200"),
DisplayName: pulumi.String("apiname1463"),
Path: pulumi.String("graphql-api"),
Protocols: pulumi.StringArray{
pulumi.String(apimanagement.ProtocolHttp),
pulumi.String(apimanagement.ProtocolHttps),
},
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
ServiceUrl: pulumi.String("https://api.spacex.land/graphql"),
})
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.Api;
import com.pulumi.azurenative.apimanagement.ApiArgs;
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 api = new Api("api", ApiArgs.builder()
.apiId("tempgroup")
.apiType("graphql")
.description("apidescription5200")
.displayName("apiname1463")
.path("graphql-api")
.protocols(
"http",
"https")
.resourceGroupName("rg1")
.serviceName("apimService1")
.serviceUrl("https://api.spacex.land/graphql")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const api = new azure_native.apimanagement.Api("api", {
apiId: "tempgroup",
apiType: azure_native.apimanagement.ApiType.Graphql,
description: "apidescription5200",
displayName: "apiname1463",
path: "graphql-api",
protocols: [
azure_native.apimanagement.Protocol.Http,
azure_native.apimanagement.Protocol.Https,
],
resourceGroupName: "rg1",
serviceName: "apimService1",
serviceUrl: "https://api.spacex.land/graphql",
});
import pulumi
import pulumi_azure_native as azure_native
api = azure_native.apimanagement.Api("api",
api_id="tempgroup",
api_type=azure_native.apimanagement.ApiType.GRAPHQL,
description="apidescription5200",
display_name="apiname1463",
path="graphql-api",
protocols=[
azure_native.apimanagement.Protocol.HTTP,
azure_native.apimanagement.Protocol.HTTPS,
],
resource_group_name="rg1",
service_name="apimService1",
service_url="https://api.spacex.land/graphql")
resources:
api:
type: azure-native:apimanagement:Api
properties:
apiId: tempgroup
apiType: graphql
description: apidescription5200
displayName: apiname1463
path: graphql-api
protocols:
- http
- https
resourceGroupName: rg1
serviceName: apimService1
serviceUrl: https://api.spacex.land/graphql
ApiManagementCreateSoapPassThroughApiUsingWsdlImport
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var api = new AzureNative.ApiManagement.Api("api", new()
{
ApiId = "soapApi",
Format = AzureNative.ApiManagement.ContentFormat.Wsdl_link,
Path = "currency",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
SoapApiType = AzureNative.ApiManagement.SoapApiType.SoapPassThrough,
Value = "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL",
WsdlSelector = new AzureNative.ApiManagement.Inputs.ApiCreateOrUpdatePropertiesWsdlSelectorArgs
{
WsdlEndpointName = "CurrencyConvertorSoap",
WsdlServiceName = "CurrencyConvertor",
},
});
});
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.NewApi(ctx, "api", &apimanagement.ApiArgs{
ApiId: pulumi.String("soapApi"),
Format: pulumi.String(apimanagement.ContentFormat_Wsdl_Link),
Path: pulumi.String("currency"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
SoapApiType: pulumi.String(apimanagement.SoapApiTypeSoapPassThrough),
Value: pulumi.String("http://www.webservicex.net/CurrencyConvertor.asmx?WSDL"),
WsdlSelector: &apimanagement.ApiCreateOrUpdatePropertiesWsdlSelectorArgs{
WsdlEndpointName: pulumi.String("CurrencyConvertorSoap"),
WsdlServiceName: pulumi.String("CurrencyConvertor"),
},
})
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.Api;
import com.pulumi.azurenative.apimanagement.ApiArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiCreateOrUpdatePropertiesWsdlSelectorArgs;
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 api = new Api("api", ApiArgs.builder()
.apiId("soapApi")
.format("wsdl-link")
.path("currency")
.resourceGroupName("rg1")
.serviceName("apimService1")
.soapApiType("soap")
.value("http://www.webservicex.net/CurrencyConvertor.asmx?WSDL")
.wsdlSelector(ApiCreateOrUpdatePropertiesWsdlSelectorArgs.builder()
.wsdlEndpointName("CurrencyConvertorSoap")
.wsdlServiceName("CurrencyConvertor")
.build())
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const api = new azure_native.apimanagement.Api("api", {
apiId: "soapApi",
format: azure_native.apimanagement.ContentFormat.Wsdl_link,
path: "currency",
resourceGroupName: "rg1",
serviceName: "apimService1",
soapApiType: azure_native.apimanagement.SoapApiType.SoapPassThrough,
value: "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL",
wsdlSelector: {
wsdlEndpointName: "CurrencyConvertorSoap",
wsdlServiceName: "CurrencyConvertor",
},
});
import pulumi
import pulumi_azure_native as azure_native
api = azure_native.apimanagement.Api("api",
api_id="soapApi",
format=azure_native.apimanagement.ContentFormat.WSDL_LINK,
path="currency",
resource_group_name="rg1",
service_name="apimService1",
soap_api_type=azure_native.apimanagement.SoapApiType.SOAP_PASS_THROUGH,
value="http://www.webservicex.net/CurrencyConvertor.asmx?WSDL",
wsdl_selector={
"wsdl_endpoint_name": "CurrencyConvertorSoap",
"wsdl_service_name": "CurrencyConvertor",
})
resources:
api:
type: azure-native:apimanagement:Api
properties:
apiId: soapApi
format: wsdl-link
path: currency
resourceGroupName: rg1
serviceName: apimService1
soapApiType: soap
value: http://www.webservicex.net/CurrencyConvertor.asmx?WSDL
wsdlSelector:
wsdlEndpointName: CurrencyConvertorSoap
wsdlServiceName: CurrencyConvertor
ApiManagementCreateSoapToRestApiUsingWsdlImport
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var api = new AzureNative.ApiManagement.Api("api", new()
{
ApiId = "soapApi",
Format = AzureNative.ApiManagement.ContentFormat.Wsdl_link,
Path = "currency",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
Value = "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL",
WsdlSelector = new AzureNative.ApiManagement.Inputs.ApiCreateOrUpdatePropertiesWsdlSelectorArgs
{
WsdlEndpointName = "CurrencyConvertorSoap",
WsdlServiceName = "CurrencyConvertor",
},
});
});
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.NewApi(ctx, "api", &apimanagement.ApiArgs{
ApiId: pulumi.String("soapApi"),
Format: pulumi.String(apimanagement.ContentFormat_Wsdl_Link),
Path: pulumi.String("currency"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
Value: pulumi.String("http://www.webservicex.net/CurrencyConvertor.asmx?WSDL"),
WsdlSelector: &apimanagement.ApiCreateOrUpdatePropertiesWsdlSelectorArgs{
WsdlEndpointName: pulumi.String("CurrencyConvertorSoap"),
WsdlServiceName: pulumi.String("CurrencyConvertor"),
},
})
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.Api;
import com.pulumi.azurenative.apimanagement.ApiArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiCreateOrUpdatePropertiesWsdlSelectorArgs;
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 api = new Api("api", ApiArgs.builder()
.apiId("soapApi")
.format("wsdl-link")
.path("currency")
.resourceGroupName("rg1")
.serviceName("apimService1")
.value("http://www.webservicex.net/CurrencyConvertor.asmx?WSDL")
.wsdlSelector(ApiCreateOrUpdatePropertiesWsdlSelectorArgs.builder()
.wsdlEndpointName("CurrencyConvertorSoap")
.wsdlServiceName("CurrencyConvertor")
.build())
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const api = new azure_native.apimanagement.Api("api", {
apiId: "soapApi",
format: azure_native.apimanagement.ContentFormat.Wsdl_link,
path: "currency",
resourceGroupName: "rg1",
serviceName: "apimService1",
value: "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL",
wsdlSelector: {
wsdlEndpointName: "CurrencyConvertorSoap",
wsdlServiceName: "CurrencyConvertor",
},
});
import pulumi
import pulumi_azure_native as azure_native
api = azure_native.apimanagement.Api("api",
api_id="soapApi",
format=azure_native.apimanagement.ContentFormat.WSDL_LINK,
path="currency",
resource_group_name="rg1",
service_name="apimService1",
value="http://www.webservicex.net/CurrencyConvertor.asmx?WSDL",
wsdl_selector={
"wsdl_endpoint_name": "CurrencyConvertorSoap",
"wsdl_service_name": "CurrencyConvertor",
})
resources:
api:
type: azure-native:apimanagement:Api
properties:
apiId: soapApi
format: wsdl-link
path: currency
resourceGroupName: rg1
serviceName: apimService1
value: http://www.webservicex.net/CurrencyConvertor.asmx?WSDL
wsdlSelector:
wsdlEndpointName: CurrencyConvertorSoap
wsdlServiceName: CurrencyConvertor
ApiManagementCreateWebSocketApi
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var api = new AzureNative.ApiManagement.Api("api", new()
{
ApiId = "tempgroup",
ApiType = AzureNative.ApiManagement.ApiType.Websocket,
Description = "apidescription5200",
DisplayName = "apiname1463",
Path = "newapiPath",
Protocols = new[]
{
AzureNative.ApiManagement.Protocol.Wss,
AzureNative.ApiManagement.Protocol.Ws,
},
ResourceGroupName = "rg1",
ServiceName = "apimService1",
ServiceUrl = "wss://echo.websocket.org",
});
});
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.NewApi(ctx, "api", &apimanagement.ApiArgs{
ApiId: pulumi.String("tempgroup"),
ApiType: pulumi.String(apimanagement.ApiTypeWebsocket),
Description: pulumi.String("apidescription5200"),
DisplayName: pulumi.String("apiname1463"),
Path: pulumi.String("newapiPath"),
Protocols: pulumi.StringArray{
pulumi.String(apimanagement.ProtocolWss),
pulumi.String(apimanagement.ProtocolWs),
},
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
ServiceUrl: pulumi.String("wss://echo.websocket.org"),
})
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.Api;
import com.pulumi.azurenative.apimanagement.ApiArgs;
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 api = new Api("api", ApiArgs.builder()
.apiId("tempgroup")
.apiType("websocket")
.description("apidescription5200")
.displayName("apiname1463")
.path("newapiPath")
.protocols(
"wss",
"ws")
.resourceGroupName("rg1")
.serviceName("apimService1")
.serviceUrl("wss://echo.websocket.org")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const api = new azure_native.apimanagement.Api("api", {
apiId: "tempgroup",
apiType: azure_native.apimanagement.ApiType.Websocket,
description: "apidescription5200",
displayName: "apiname1463",
path: "newapiPath",
protocols: [
azure_native.apimanagement.Protocol.Wss,
azure_native.apimanagement.Protocol.Ws,
],
resourceGroupName: "rg1",
serviceName: "apimService1",
serviceUrl: "wss://echo.websocket.org",
});
import pulumi
import pulumi_azure_native as azure_native
api = azure_native.apimanagement.Api("api",
api_id="tempgroup",
api_type=azure_native.apimanagement.ApiType.WEBSOCKET,
description="apidescription5200",
display_name="apiname1463",
path="newapiPath",
protocols=[
azure_native.apimanagement.Protocol.WSS,
azure_native.apimanagement.Protocol.WS,
],
resource_group_name="rg1",
service_name="apimService1",
service_url="wss://echo.websocket.org")
resources:
api:
type: azure-native:apimanagement:Api
properties:
apiId: tempgroup
apiType: websocket
description: apidescription5200
displayName: apiname1463
path: newapiPath
protocols:
- wss
- ws
resourceGroupName: rg1
serviceName: apimService1
serviceUrl: wss://echo.websocket.org
Create Api Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Api(name: string, args: ApiArgs, opts?: CustomResourceOptions);@overload
def Api(resource_name: str,
args: ApiArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Api(resource_name: str,
opts: Optional[ResourceOptions] = None,
path: Optional[str] = None,
service_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
license: Optional[ApiLicenseInformationArgs] = None,
protocols: Optional[Sequence[Union[str, Protocol]]] = None,
api_version_description: Optional[str] = None,
api_version_set: Optional[ApiVersionSetContractDetailsArgs] = None,
api_version_set_id: Optional[str] = None,
authentication_settings: Optional[AuthenticationSettingsContractArgs] = None,
contact: Optional[ApiContactInformationArgs] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
format: Optional[Union[str, ContentFormat]] = None,
is_current: Optional[bool] = None,
api_id: Optional[str] = None,
api_type: Optional[Union[str, ApiType]] = None,
api_version: Optional[str] = None,
api_revision_description: Optional[str] = None,
api_revision: Optional[str] = None,
service_url: Optional[str] = None,
soap_api_type: Optional[Union[str, SoapApiType]] = None,
source_api_id: Optional[str] = None,
subscription_key_parameter_names: Optional[SubscriptionKeyParameterNamesContractArgs] = None,
subscription_required: Optional[bool] = None,
terms_of_service_url: Optional[str] = None,
translate_required_query_parameters_conduct: Optional[Union[str, TranslateRequiredQueryParametersConduct]] = None,
value: Optional[str] = None,
wsdl_selector: Optional[ApiCreateOrUpdatePropertiesWsdlSelectorArgs] = None)func NewApi(ctx *Context, name string, args ApiArgs, opts ...ResourceOption) (*Api, error)public Api(string name, ApiArgs args, CustomResourceOptions? opts = null)type: azure-native:apimanagement:Api
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 ApiArgs
- 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 ApiArgs
- 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 ApiArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApiArgs
- 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 azure_nativeApiResource = new AzureNative.ApiManagement.Api("azure-nativeApiResource", new()
{
Path = "string",
ServiceName = "string",
ResourceGroupName = "string",
License = new AzureNative.ApiManagement.Inputs.ApiLicenseInformationArgs
{
Name = "string",
Url = "string",
},
Protocols = new[]
{
"string",
},
ApiVersionDescription = "string",
ApiVersionSet = new AzureNative.ApiManagement.Inputs.ApiVersionSetContractDetailsArgs
{
Description = "string",
Id = "string",
Name = "string",
VersionHeaderName = "string",
VersionQueryName = "string",
VersioningScheme = "string",
},
ApiVersionSetId = "string",
AuthenticationSettings = new AzureNative.ApiManagement.Inputs.AuthenticationSettingsContractArgs
{
OAuth2 = new AzureNative.ApiManagement.Inputs.OAuth2AuthenticationSettingsContractArgs
{
AuthorizationServerId = "string",
Scope = "string",
},
OAuth2AuthenticationSettings = new[]
{
new AzureNative.ApiManagement.Inputs.OAuth2AuthenticationSettingsContractArgs
{
AuthorizationServerId = "string",
Scope = "string",
},
},
Openid = new AzureNative.ApiManagement.Inputs.OpenIdAuthenticationSettingsContractArgs
{
BearerTokenSendingMethods = new[]
{
"string",
},
OpenidProviderId = "string",
},
OpenidAuthenticationSettings = new[]
{
new AzureNative.ApiManagement.Inputs.OpenIdAuthenticationSettingsContractArgs
{
BearerTokenSendingMethods = new[]
{
"string",
},
OpenidProviderId = "string",
},
},
},
Contact = new AzureNative.ApiManagement.Inputs.ApiContactInformationArgs
{
Email = "string",
Name = "string",
Url = "string",
},
Description = "string",
DisplayName = "string",
Format = "string",
IsCurrent = false,
ApiId = "string",
ApiType = "string",
ApiVersion = "string",
ApiRevisionDescription = "string",
ApiRevision = "string",
ServiceUrl = "string",
SoapApiType = "string",
SourceApiId = "string",
SubscriptionKeyParameterNames = new AzureNative.ApiManagement.Inputs.SubscriptionKeyParameterNamesContractArgs
{
Header = "string",
Query = "string",
},
SubscriptionRequired = false,
TermsOfServiceUrl = "string",
TranslateRequiredQueryParametersConduct = "string",
Value = "string",
WsdlSelector = new AzureNative.ApiManagement.Inputs.ApiCreateOrUpdatePropertiesWsdlSelectorArgs
{
WsdlEndpointName = "string",
WsdlServiceName = "string",
},
});
example, err := apimanagement.NewApi(ctx, "azure-nativeApiResource", &apimanagement.ApiArgs{
Path: pulumi.String("string"),
ServiceName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
License: &apimanagement.ApiLicenseInformationArgs{
Name: pulumi.String("string"),
Url: pulumi.String("string"),
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
ApiVersionDescription: pulumi.String("string"),
ApiVersionSet: &apimanagement.ApiVersionSetContractDetailsArgs{
Description: pulumi.String("string"),
Id: pulumi.String("string"),
Name: pulumi.String("string"),
VersionHeaderName: pulumi.String("string"),
VersionQueryName: pulumi.String("string"),
VersioningScheme: pulumi.String("string"),
},
ApiVersionSetId: pulumi.String("string"),
AuthenticationSettings: &apimanagement.AuthenticationSettingsContractArgs{
OAuth2: &apimanagement.OAuth2AuthenticationSettingsContractArgs{
AuthorizationServerId: pulumi.String("string"),
Scope: pulumi.String("string"),
},
OAuth2AuthenticationSettings: apimanagement.OAuth2AuthenticationSettingsContractArray{
&apimanagement.OAuth2AuthenticationSettingsContractArgs{
AuthorizationServerId: pulumi.String("string"),
Scope: pulumi.String("string"),
},
},
Openid: &apimanagement.OpenIdAuthenticationSettingsContractArgs{
BearerTokenSendingMethods: pulumi.StringArray{
pulumi.String("string"),
},
OpenidProviderId: pulumi.String("string"),
},
OpenidAuthenticationSettings: apimanagement.OpenIdAuthenticationSettingsContractArray{
&apimanagement.OpenIdAuthenticationSettingsContractArgs{
BearerTokenSendingMethods: pulumi.StringArray{
pulumi.String("string"),
},
OpenidProviderId: pulumi.String("string"),
},
},
},
Contact: &apimanagement.ApiContactInformationArgs{
Email: pulumi.String("string"),
Name: pulumi.String("string"),
Url: pulumi.String("string"),
},
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
Format: pulumi.String("string"),
IsCurrent: pulumi.Bool(false),
ApiId: pulumi.String("string"),
ApiType: pulumi.String("string"),
ApiVersion: pulumi.String("string"),
ApiRevisionDescription: pulumi.String("string"),
ApiRevision: pulumi.String("string"),
ServiceUrl: pulumi.String("string"),
SoapApiType: pulumi.String("string"),
SourceApiId: pulumi.String("string"),
SubscriptionKeyParameterNames: &apimanagement.SubscriptionKeyParameterNamesContractArgs{
Header: pulumi.String("string"),
Query: pulumi.String("string"),
},
SubscriptionRequired: pulumi.Bool(false),
TermsOfServiceUrl: pulumi.String("string"),
TranslateRequiredQueryParametersConduct: pulumi.String("string"),
Value: pulumi.String("string"),
WsdlSelector: &apimanagement.ApiCreateOrUpdatePropertiesWsdlSelectorArgs{
WsdlEndpointName: pulumi.String("string"),
WsdlServiceName: pulumi.String("string"),
},
})
var azure_nativeApiResource = new Api("azure-nativeApiResource", ApiArgs.builder()
.path("string")
.serviceName("string")
.resourceGroupName("string")
.license(ApiLicenseInformationArgs.builder()
.name("string")
.url("string")
.build())
.protocols("string")
.apiVersionDescription("string")
.apiVersionSet(ApiVersionSetContractDetailsArgs.builder()
.description("string")
.id("string")
.name("string")
.versionHeaderName("string")
.versionQueryName("string")
.versioningScheme("string")
.build())
.apiVersionSetId("string")
.authenticationSettings(AuthenticationSettingsContractArgs.builder()
.oAuth2(OAuth2AuthenticationSettingsContractArgs.builder()
.authorizationServerId("string")
.scope("string")
.build())
.oAuth2AuthenticationSettings(OAuth2AuthenticationSettingsContractArgs.builder()
.authorizationServerId("string")
.scope("string")
.build())
.openid(OpenIdAuthenticationSettingsContractArgs.builder()
.bearerTokenSendingMethods("string")
.openidProviderId("string")
.build())
.openidAuthenticationSettings(OpenIdAuthenticationSettingsContractArgs.builder()
.bearerTokenSendingMethods("string")
.openidProviderId("string")
.build())
.build())
.contact(ApiContactInformationArgs.builder()
.email("string")
.name("string")
.url("string")
.build())
.description("string")
.displayName("string")
.format("string")
.isCurrent(false)
.apiId("string")
.apiType("string")
.apiVersion("string")
.apiRevisionDescription("string")
.apiRevision("string")
.serviceUrl("string")
.soapApiType("string")
.sourceApiId("string")
.subscriptionKeyParameterNames(SubscriptionKeyParameterNamesContractArgs.builder()
.header("string")
.query("string")
.build())
.subscriptionRequired(false)
.termsOfServiceUrl("string")
.translateRequiredQueryParametersConduct("string")
.value("string")
.wsdlSelector(ApiCreateOrUpdatePropertiesWsdlSelectorArgs.builder()
.wsdlEndpointName("string")
.wsdlServiceName("string")
.build())
.build());
azure_native_api_resource = azure_native.apimanagement.Api("azure-nativeApiResource",
path="string",
service_name="string",
resource_group_name="string",
license={
"name": "string",
"url": "string",
},
protocols=["string"],
api_version_description="string",
api_version_set={
"description": "string",
"id": "string",
"name": "string",
"version_header_name": "string",
"version_query_name": "string",
"versioning_scheme": "string",
},
api_version_set_id="string",
authentication_settings={
"o_auth2": {
"authorization_server_id": "string",
"scope": "string",
},
"o_auth2_authentication_settings": [{
"authorization_server_id": "string",
"scope": "string",
}],
"openid": {
"bearer_token_sending_methods": ["string"],
"openid_provider_id": "string",
},
"openid_authentication_settings": [{
"bearer_token_sending_methods": ["string"],
"openid_provider_id": "string",
}],
},
contact={
"email": "string",
"name": "string",
"url": "string",
},
description="string",
display_name="string",
format="string",
is_current=False,
api_id="string",
api_type="string",
api_version="string",
api_revision_description="string",
api_revision="string",
service_url="string",
soap_api_type="string",
source_api_id="string",
subscription_key_parameter_names={
"header": "string",
"query": "string",
},
subscription_required=False,
terms_of_service_url="string",
translate_required_query_parameters_conduct="string",
value="string",
wsdl_selector={
"wsdl_endpoint_name": "string",
"wsdl_service_name": "string",
})
const azure_nativeApiResource = new azure_native.apimanagement.Api("azure-nativeApiResource", {
path: "string",
serviceName: "string",
resourceGroupName: "string",
license: {
name: "string",
url: "string",
},
protocols: ["string"],
apiVersionDescription: "string",
apiVersionSet: {
description: "string",
id: "string",
name: "string",
versionHeaderName: "string",
versionQueryName: "string",
versioningScheme: "string",
},
apiVersionSetId: "string",
authenticationSettings: {
oAuth2: {
authorizationServerId: "string",
scope: "string",
},
oAuth2AuthenticationSettings: [{
authorizationServerId: "string",
scope: "string",
}],
openid: {
bearerTokenSendingMethods: ["string"],
openidProviderId: "string",
},
openidAuthenticationSettings: [{
bearerTokenSendingMethods: ["string"],
openidProviderId: "string",
}],
},
contact: {
email: "string",
name: "string",
url: "string",
},
description: "string",
displayName: "string",
format: "string",
isCurrent: false,
apiId: "string",
apiType: "string",
apiVersion: "string",
apiRevisionDescription: "string",
apiRevision: "string",
serviceUrl: "string",
soapApiType: "string",
sourceApiId: "string",
subscriptionKeyParameterNames: {
header: "string",
query: "string",
},
subscriptionRequired: false,
termsOfServiceUrl: "string",
translateRequiredQueryParametersConduct: "string",
value: "string",
wsdlSelector: {
wsdlEndpointName: "string",
wsdlServiceName: "string",
},
});
type: azure-native:apimanagement:Api
properties:
apiId: string
apiRevision: string
apiRevisionDescription: string
apiType: string
apiVersion: string
apiVersionDescription: string
apiVersionSet:
description: string
id: string
name: string
versionHeaderName: string
versionQueryName: string
versioningScheme: string
apiVersionSetId: string
authenticationSettings:
oAuth2:
authorizationServerId: string
scope: string
oAuth2AuthenticationSettings:
- authorizationServerId: string
scope: string
openid:
bearerTokenSendingMethods:
- string
openidProviderId: string
openidAuthenticationSettings:
- bearerTokenSendingMethods:
- string
openidProviderId: string
contact:
email: string
name: string
url: string
description: string
displayName: string
format: string
isCurrent: false
license:
name: string
url: string
path: string
protocols:
- string
resourceGroupName: string
serviceName: string
serviceUrl: string
soapApiType: string
sourceApiId: string
subscriptionKeyParameterNames:
header: string
query: string
subscriptionRequired: false
termsOfServiceUrl: string
translateRequiredQueryParametersConduct: string
value: string
wsdlSelector:
wsdlEndpointName: string
wsdlServiceName: string
Api 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 Api resource accepts the following input properties:
- Path string
- Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Api
Id string - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- Api
Revision string - Describes the revision of the API. If no value is provided, default revision 1 is created
- Api
Revision stringDescription - Description of the API Revision.
- Api
Type string | Pulumi.Azure Native. Api Management. Api Type - Type of API.
- Api
Version string - Indicates the version identifier of the API if the API is versioned
- Api
Version stringDescription - Description of the API Version.
- Api
Version Pulumi.Set Azure Native. Api Management. Inputs. Api Version Set Contract Details - Version set details
- Api
Version stringSet Id - A resource identifier for the related ApiVersionSet.
- Authentication
Settings Pulumi.Azure Native. Api Management. Inputs. Authentication Settings Contract - Collection of authentication settings included into this API.
- Contact
Pulumi.
Azure Native. Api Management. Inputs. Api Contact Information - Contact information for the API.
- Description string
- Description of the API. May include HTML formatting tags.
- Display
Name string - API name. Must be 1 to 300 characters long.
- Format
string | Pulumi.
Azure Native. Api Management. Content Format - Format of the Content in which the API is getting imported.
- Is
Current bool - Indicates if API revision is current api revision.
- License
Pulumi.
Azure Native. Api Management. Inputs. Api License Information - License information for the API.
- Protocols
List<Union<string, Pulumi.
Azure Native. Api Management. Protocol>> - Describes on which protocols the operations in this API can be invoked.
- Service
Url string - Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
- Soap
Api string | Pulumi.Type Azure Native. Api Management. Soap Api Type - Type of API to create.
httpcreates a REST APIsoapcreates a SOAP pass-through APIwebsocketcreates websocket APIgraphqlcreates GraphQL API.
- Source
Api stringId - API identifier of the source API.
- Subscription
Key Pulumi.Parameter Names Azure Native. Api Management. Inputs. Subscription Key Parameter Names Contract - Protocols over which API is made available.
- Subscription
Required bool - Specifies whether an API or Product subscription is required for accessing the API.
- Terms
Of stringService Url - A URL to the Terms of Service for the API. MUST be in the format of a URL.
- Translate
Required string | Pulumi.Query Parameters Conduct Azure Native. Api Management. Translate Required Query Parameters Conduct - Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'
- Value string
- Content value when Importing an API.
- Wsdl
Selector Pulumi.Azure Native. Api Management. Inputs. Api Create Or Update Properties Wsdl Selector - Criteria to limit import of WSDL to a subset of the document.
- Path string
- Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Api
Id string - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- Api
Revision string - Describes the revision of the API. If no value is provided, default revision 1 is created
- Api
Revision stringDescription - Description of the API Revision.
- Api
Type string | ApiType - Type of API.
- Api
Version string - Indicates the version identifier of the API if the API is versioned
- Api
Version stringDescription - Description of the API Version.
- Api
Version ApiSet Version Set Contract Details Args - Version set details
- Api
Version stringSet Id - A resource identifier for the related ApiVersionSet.
- Authentication
Settings AuthenticationSettings Contract Args - Collection of authentication settings included into this API.
- Contact
Api
Contact Information Args - Contact information for the API.
- Description string
- Description of the API. May include HTML formatting tags.
- Display
Name string - API name. Must be 1 to 300 characters long.
- Format
string | Content
Format - Format of the Content in which the API is getting imported.
- Is
Current bool - Indicates if API revision is current api revision.
- License
Api
License Information Args - License information for the API.
- Protocols []string
- Describes on which protocols the operations in this API can be invoked.
- Service
Url string - Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
- Soap
Api string | SoapType Api Type - Type of API to create.
httpcreates a REST APIsoapcreates a SOAP pass-through APIwebsocketcreates websocket APIgraphqlcreates GraphQL API.
- Source
Api stringId - API identifier of the source API.
- Subscription
Key SubscriptionParameter Names Key Parameter Names Contract Args - Protocols over which API is made available.
- Subscription
Required bool - Specifies whether an API or Product subscription is required for accessing the API.
- Terms
Of stringService Url - A URL to the Terms of Service for the API. MUST be in the format of a URL.
- Translate
Required string | TranslateQuery Parameters Conduct Required Query Parameters Conduct - Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'
- Value string
- Content value when Importing an API.
- Wsdl
Selector ApiCreate Or Update Properties Wsdl Selector Args - Criteria to limit import of WSDL to a subset of the document.
- path String
- Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- api
Id String - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- api
Revision String - Describes the revision of the API. If no value is provided, default revision 1 is created
- api
Revision StringDescription - Description of the API Revision.
- api
Type String | ApiType - Type of API.
- api
Version String - Indicates the version identifier of the API if the API is versioned
- api
Version StringDescription - Description of the API Version.
- api
Version ApiSet Version Set Contract Details - Version set details
- api
Version StringSet Id - A resource identifier for the related ApiVersionSet.
- authentication
Settings AuthenticationSettings Contract - Collection of authentication settings included into this API.
- contact
Api
Contact Information - Contact information for the API.
- description String
- Description of the API. May include HTML formatting tags.
- display
Name String - API name. Must be 1 to 300 characters long.
- format
String | Content
Format - Format of the Content in which the API is getting imported.
- is
Current Boolean - Indicates if API revision is current api revision.
- license
Api
License Information - License information for the API.
- protocols List<Either<String,Protocol>>
- Describes on which protocols the operations in this API can be invoked.
- service
Url String - Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
- soap
Api String | SoapType Api Type - Type of API to create.
httpcreates a REST APIsoapcreates a SOAP pass-through APIwebsocketcreates websocket APIgraphqlcreates GraphQL API.
- source
Api StringId - API identifier of the source API.
- subscription
Key SubscriptionParameter Names Key Parameter Names Contract - Protocols over which API is made available.
- subscription
Required Boolean - Specifies whether an API or Product subscription is required for accessing the API.
- terms
Of StringService Url - A URL to the Terms of Service for the API. MUST be in the format of a URL.
- translate
Required String | TranslateQuery Parameters Conduct Required Query Parameters Conduct - Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'
- value String
- Content value when Importing an API.
- wsdl
Selector ApiCreate Or Update Properties Wsdl Selector - Criteria to limit import of WSDL to a subset of the document.
- path string
- Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- api
Id string - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- api
Revision string - Describes the revision of the API. If no value is provided, default revision 1 is created
- api
Revision stringDescription - Description of the API Revision.
- api
Type string | ApiType - Type of API.
- api
Version string - Indicates the version identifier of the API if the API is versioned
- api
Version stringDescription - Description of the API Version.
- api
Version ApiSet Version Set Contract Details - Version set details
- api
Version stringSet Id - A resource identifier for the related ApiVersionSet.
- authentication
Settings AuthenticationSettings Contract - Collection of authentication settings included into this API.
- contact
Api
Contact Information - Contact information for the API.
- description string
- Description of the API. May include HTML formatting tags.
- display
Name string - API name. Must be 1 to 300 characters long.
- format
string | Content
Format - Format of the Content in which the API is getting imported.
- is
Current boolean - Indicates if API revision is current api revision.
- license
Api
License Information - License information for the API.
- protocols (string | Protocol)[]
- Describes on which protocols the operations in this API can be invoked.
- service
Url string - Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
- soap
Api string | SoapType Api Type - Type of API to create.
httpcreates a REST APIsoapcreates a SOAP pass-through APIwebsocketcreates websocket APIgraphqlcreates GraphQL API.
- source
Api stringId - API identifier of the source API.
- subscription
Key SubscriptionParameter Names Key Parameter Names Contract - Protocols over which API is made available.
- subscription
Required boolean - Specifies whether an API or Product subscription is required for accessing the API.
- terms
Of stringService Url - A URL to the Terms of Service for the API. MUST be in the format of a URL.
- translate
Required string | TranslateQuery Parameters Conduct Required Query Parameters Conduct - Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'
- value string
- Content value when Importing an API.
- wsdl
Selector ApiCreate Or Update Properties Wsdl Selector - Criteria to limit import of WSDL to a subset of the document.
- path str
- Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- service_
name str - The name of the API Management service.
- api_
id str - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- api_
revision str - Describes the revision of the API. If no value is provided, default revision 1 is created
- api_
revision_ strdescription - Description of the API Revision.
- api_
type str | ApiType - Type of API.
- api_
version str - Indicates the version identifier of the API if the API is versioned
- api_
version_ strdescription - Description of the API Version.
- api_
version_ Apiset Version Set Contract Details Args - Version set details
- api_
version_ strset_ id - A resource identifier for the related ApiVersionSet.
- authentication_
settings AuthenticationSettings Contract Args - Collection of authentication settings included into this API.
- contact
Api
Contact Information Args - Contact information for the API.
- description str
- Description of the API. May include HTML formatting tags.
- display_
name str - API name. Must be 1 to 300 characters long.
- format
str | Content
Format - Format of the Content in which the API is getting imported.
- is_
current bool - Indicates if API revision is current api revision.
- license
Api
License Information Args - License information for the API.
- protocols Sequence[Union[str, Protocol]]
- Describes on which protocols the operations in this API can be invoked.
- service_
url str - Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
- soap_
api_ str | Soaptype Api Type - Type of API to create.
httpcreates a REST APIsoapcreates a SOAP pass-through APIwebsocketcreates websocket APIgraphqlcreates GraphQL API.
- source_
api_ strid - API identifier of the source API.
- subscription_
key_ Subscriptionparameter_ names Key Parameter Names Contract Args - Protocols over which API is made available.
- subscription_
required bool - Specifies whether an API or Product subscription is required for accessing the API.
- terms_
of_ strservice_ url - A URL to the Terms of Service for the API. MUST be in the format of a URL.
- translate_
required_ str | Translatequery_ parameters_ conduct Required Query Parameters Conduct - Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'
- value str
- Content value when Importing an API.
- wsdl_
selector ApiCreate Or Update Properties Wsdl Selector Args - Criteria to limit import of WSDL to a subset of the document.
- path String
- Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- api
Id String - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- api
Revision String - Describes the revision of the API. If no value is provided, default revision 1 is created
- api
Revision StringDescription - Description of the API Revision.
- api
Type String | "http" | "soap" | "websocket" | "graphql" - Type of API.
- api
Version String - Indicates the version identifier of the API if the API is versioned
- api
Version StringDescription - Description of the API Version.
- api
Version Property MapSet - Version set details
- api
Version StringSet Id - A resource identifier for the related ApiVersionSet.
- authentication
Settings Property Map - Collection of authentication settings included into this API.
- contact Property Map
- Contact information for the API.
- description String
- Description of the API. May include HTML formatting tags.
- display
Name String - API name. Must be 1 to 300 characters long.
- format String | "wadl-xml" | "wadl-link-json" | "swagger-json" | "swagger-link-json" | "wsdl" | "wsdl-link" | "openapi" | "openapi+json" | "openapi-link" | "openapi+json-link" | "graphql-link"
- Format of the Content in which the API is getting imported.
- is
Current Boolean - Indicates if API revision is current api revision.
- license Property Map
- License information for the API.
- protocols List<String | "http" | "https" | "ws" | "wss">
- Describes on which protocols the operations in this API can be invoked.
- service
Url String - Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
- soap
Api String | "http" | "soap" | "websocket" | "graphql"Type - Type of API to create.
httpcreates a REST APIsoapcreates a SOAP pass-through APIwebsocketcreates websocket APIgraphqlcreates GraphQL API.
- source
Api StringId - API identifier of the source API.
- subscription
Key Property MapParameter Names - Protocols over which API is made available.
- subscription
Required Boolean - Specifies whether an API or Product subscription is required for accessing the API.
- terms
Of StringService Url - A URL to the Terms of Service for the API. MUST be in the format of a URL.
- translate
Required String | "template" | "query"Query Parameters Conduct - Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'
- value String
- Content value when Importing an API.
- wsdl
Selector Property Map - Criteria to limit import of WSDL to a subset of the document.
Outputs
All input properties are implicitly available as output properties. Additionally, the Api resource produces the following output properties:
Supporting Types
ApiContactInformation, ApiContactInformationArgs
ApiContactInformationResponse, ApiContactInformationResponseArgs
ApiCreateOrUpdatePropertiesWsdlSelector, ApiCreateOrUpdatePropertiesWsdlSelectorArgs
- Wsdl
Endpoint stringName - Name of endpoint(port) to import from WSDL
- Wsdl
Service stringName - Name of service to import from WSDL
- Wsdl
Endpoint stringName - Name of endpoint(port) to import from WSDL
- Wsdl
Service stringName - Name of service to import from WSDL
- wsdl
Endpoint StringName - Name of endpoint(port) to import from WSDL
- wsdl
Service StringName - Name of service to import from WSDL
- wsdl
Endpoint stringName - Name of endpoint(port) to import from WSDL
- wsdl
Service stringName - Name of service to import from WSDL
- wsdl_
endpoint_ strname - Name of endpoint(port) to import from WSDL
- wsdl_
service_ strname - Name of service to import from WSDL
- wsdl
Endpoint StringName - Name of endpoint(port) to import from WSDL
- wsdl
Service StringName - Name of service to import from WSDL
ApiLicenseInformation, ApiLicenseInformationArgs
ApiLicenseInformationResponse, ApiLicenseInformationResponseArgs
ApiType, ApiTypeArgs
- Http
- http
- Soap
- soap
- Websocket
- websocket
- Graphql
- graphql
- Api
Type Http - http
- Api
Type Soap - soap
- Api
Type Websocket - websocket
- Api
Type Graphql - graphql
- Http
- http
- Soap
- soap
- Websocket
- websocket
- Graphql
- graphql
- Http
- http
- Soap
- soap
- Websocket
- websocket
- Graphql
- graphql
- HTTP
- http
- SOAP
- soap
- WEBSOCKET
- websocket
- GRAPHQL
- graphql
- "http"
- http
- "soap"
- soap
- "websocket"
- websocket
- "graphql"
- graphql
ApiVersionSetContractDetails, ApiVersionSetContractDetailsArgs
- Description string
- Description of API Version Set.
- Id string
- Identifier for existing API Version Set. Omit this value to create a new Version Set.
- Name string
- The display Name of the API Version Set.
- Version
Header stringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header. - Version
Query stringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query. - Versioning
Scheme string | Pulumi.Azure Native. Api Management. Versioning Scheme - An value that determines where the API Version identifier will be located in a HTTP request.
- Description string
- Description of API Version Set.
- Id string
- Identifier for existing API Version Set. Omit this value to create a new Version Set.
- Name string
- The display Name of the API Version Set.
- Version
Header stringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header. - Version
Query stringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query. - Versioning
Scheme string | VersioningScheme - An value that determines where the API Version identifier will be located in a HTTP request.
- description String
- Description of API Version Set.
- id String
- Identifier for existing API Version Set. Omit this value to create a new Version Set.
- name String
- The display Name of the API Version Set.
- version
Header StringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header. - version
Query StringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query. - versioning
Scheme String | VersioningScheme - An value that determines where the API Version identifier will be located in a HTTP request.
- description string
- Description of API Version Set.
- id string
- Identifier for existing API Version Set. Omit this value to create a new Version Set.
- name string
- The display Name of the API Version Set.
- version
Header stringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header. - version
Query stringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query. - versioning
Scheme string | VersioningScheme - An value that determines where the API Version identifier will be located in a HTTP request.
- description str
- Description of API Version Set.
- id str
- Identifier for existing API Version Set. Omit this value to create a new Version Set.
- name str
- The display Name of the API Version Set.
- version_
header_ strname - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header. - version_
query_ strname - Name of query parameter that indicates the API Version if versioningScheme is set to
query. - versioning_
scheme str | VersioningScheme - An value that determines where the API Version identifier will be located in a HTTP request.
- description String
- Description of API Version Set.
- id String
- Identifier for existing API Version Set. Omit this value to create a new Version Set.
- name String
- The display Name of the API Version Set.
- version
Header StringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header. - version
Query StringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query. - versioning
Scheme String | "Segment" | "Query" | "Header" - An value that determines where the API Version identifier will be located in a HTTP request.
ApiVersionSetContractDetailsResponse, ApiVersionSetContractDetailsResponseArgs
- Description string
- Description of API Version Set.
- Id string
- Identifier for existing API Version Set. Omit this value to create a new Version Set.
- Name string
- The display Name of the API Version Set.
- Version
Header stringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header. - Version
Query stringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query. - Versioning
Scheme string - An value that determines where the API Version identifier will be located in a HTTP request.
- Description string
- Description of API Version Set.
- Id string
- Identifier for existing API Version Set. Omit this value to create a new Version Set.
- Name string
- The display Name of the API Version Set.
- Version
Header stringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header. - Version
Query stringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query. - Versioning
Scheme string - An value that determines where the API Version identifier will be located in a HTTP request.
- description String
- Description of API Version Set.
- id String
- Identifier for existing API Version Set. Omit this value to create a new Version Set.
- name String
- The display Name of the API Version Set.
- version
Header StringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header. - version
Query StringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query. - versioning
Scheme String - An value that determines where the API Version identifier will be located in a HTTP request.
- description string
- Description of API Version Set.
- id string
- Identifier for existing API Version Set. Omit this value to create a new Version Set.
- name string
- The display Name of the API Version Set.
- version
Header stringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header. - version
Query stringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query. - versioning
Scheme string - An value that determines where the API Version identifier will be located in a HTTP request.
- description str
- Description of API Version Set.
- id str
- Identifier for existing API Version Set. Omit this value to create a new Version Set.
- name str
- The display Name of the API Version Set.
- version_
header_ strname - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header. - version_
query_ strname - Name of query parameter that indicates the API Version if versioningScheme is set to
query. - versioning_
scheme str - An value that determines where the API Version identifier will be located in a HTTP request.
- description String
- Description of API Version Set.
- id String
- Identifier for existing API Version Set. Omit this value to create a new Version Set.
- name String
- The display Name of the API Version Set.
- version
Header StringName - Name of HTTP header parameter that indicates the API Version if versioningScheme is set to
header. - version
Query StringName - Name of query parameter that indicates the API Version if versioningScheme is set to
query. - versioning
Scheme String - An value that determines where the API Version identifier will be located in a HTTP request.
AuthenticationSettingsContract, AuthenticationSettingsContractArgs
- OAuth2
Pulumi.
Azure Native. Api Management. Inputs. OAuth2Authentication Settings Contract - OAuth2 Authentication settings
- OAuth2Authentication
Settings List<Pulumi.Azure Native. Api Management. Inputs. OAuth2Authentication Settings Contract> - Collection of OAuth2 authentication settings included into this API.
- Openid
Pulumi.
Azure Native. Api Management. Inputs. Open Id Authentication Settings Contract - OpenID Connect Authentication Settings
- Openid
Authentication List<Pulumi.Settings Azure Native. Api Management. Inputs. Open Id Authentication Settings Contract> - Collection of Open ID Connect authentication settings included into this API.
- OAuth2
OAuth2Authentication
Settings Contract - OAuth2 Authentication settings
- OAuth2Authentication
Settings []OAuth2AuthenticationSettings Contract - Collection of OAuth2 authentication settings included into this API.
- Openid
Open
Id Authentication Settings Contract - OpenID Connect Authentication Settings
- Openid
Authentication []OpenSettings Id Authentication Settings Contract - Collection of Open ID Connect authentication settings included into this API.
- o
Auth2 OAuth2AuthenticationSettings Contract - OAuth2 Authentication settings
- o
Auth2Authentication List<OAuth2AuthenticationSettings Settings Contract> - Collection of OAuth2 authentication settings included into this API.
- openid
Open
Id Authentication Settings Contract - OpenID Connect Authentication Settings
- openid
Authentication List<OpenSettings Id Authentication Settings Contract> - Collection of Open ID Connect authentication settings included into this API.
- o
Auth2 OAuth2AuthenticationSettings Contract - OAuth2 Authentication settings
- o
Auth2Authentication OAuth2AuthenticationSettings Settings Contract[] - Collection of OAuth2 authentication settings included into this API.
- openid
Open
Id Authentication Settings Contract - OpenID Connect Authentication Settings
- openid
Authentication OpenSettings Id Authentication Settings Contract[] - Collection of Open ID Connect authentication settings included into this API.
- o_
auth2 OAuth2AuthenticationSettings Contract - OAuth2 Authentication settings
- o_
auth2_ Sequence[OAuth2Authenticationauthentication_ settings Settings Contract] - Collection of OAuth2 authentication settings included into this API.
- openid
Open
Id Authentication Settings Contract - OpenID Connect Authentication Settings
- openid_
authentication_ Sequence[Opensettings Id Authentication Settings Contract] - Collection of Open ID Connect authentication settings included into this API.
- o
Auth2 Property Map - OAuth2 Authentication settings
- o
Auth2Authentication List<Property Map>Settings - Collection of OAuth2 authentication settings included into this API.
- openid Property Map
- OpenID Connect Authentication Settings
- openid
Authentication List<Property Map>Settings - Collection of Open ID Connect authentication settings included into this API.
AuthenticationSettingsContractResponse, AuthenticationSettingsContractResponseArgs
- OAuth2
Pulumi.
Azure Native. Api Management. Inputs. OAuth2Authentication Settings Contract Response - OAuth2 Authentication settings
- OAuth2Authentication
Settings List<Pulumi.Azure Native. Api Management. Inputs. OAuth2Authentication Settings Contract Response> - Collection of OAuth2 authentication settings included into this API.
- Openid
Pulumi.
Azure Native. Api Management. Inputs. Open Id Authentication Settings Contract Response - OpenID Connect Authentication Settings
- Openid
Authentication List<Pulumi.Settings Azure Native. Api Management. Inputs. Open Id Authentication Settings Contract Response> - Collection of Open ID Connect authentication settings included into this API.
- OAuth2
OAuth2Authentication
Settings Contract Response - OAuth2 Authentication settings
- OAuth2Authentication
Settings []OAuth2AuthenticationSettings Contract Response - Collection of OAuth2 authentication settings included into this API.
- Openid
Open
Id Authentication Settings Contract Response - OpenID Connect Authentication Settings
- Openid
Authentication []OpenSettings Id Authentication Settings Contract Response - Collection of Open ID Connect authentication settings included into this API.
- o
Auth2 OAuth2AuthenticationSettings Contract Response - OAuth2 Authentication settings
- o
Auth2Authentication List<OAuth2AuthenticationSettings Settings Contract Response> - Collection of OAuth2 authentication settings included into this API.
- openid
Open
Id Authentication Settings Contract Response - OpenID Connect Authentication Settings
- openid
Authentication List<OpenSettings Id Authentication Settings Contract Response> - Collection of Open ID Connect authentication settings included into this API.
- o
Auth2 OAuth2AuthenticationSettings Contract Response - OAuth2 Authentication settings
- o
Auth2Authentication OAuth2AuthenticationSettings Settings Contract Response[] - Collection of OAuth2 authentication settings included into this API.
- openid
Open
Id Authentication Settings Contract Response - OpenID Connect Authentication Settings
- openid
Authentication OpenSettings Id Authentication Settings Contract Response[] - Collection of Open ID Connect authentication settings included into this API.
- o_
auth2 OAuth2AuthenticationSettings Contract Response - OAuth2 Authentication settings
- o_
auth2_ Sequence[OAuth2Authenticationauthentication_ settings Settings Contract Response] - Collection of OAuth2 authentication settings included into this API.
- openid
Open
Id Authentication Settings Contract Response - OpenID Connect Authentication Settings
- openid_
authentication_ Sequence[Opensettings Id Authentication Settings Contract Response] - Collection of Open ID Connect authentication settings included into this API.
- o
Auth2 Property Map - OAuth2 Authentication settings
- o
Auth2Authentication List<Property Map>Settings - Collection of OAuth2 authentication settings included into this API.
- openid Property Map
- OpenID Connect Authentication Settings
- openid
Authentication List<Property Map>Settings - Collection of Open ID Connect authentication settings included into this API.
BearerTokenSendingMethods, BearerTokenSendingMethodsArgs
- Authorization
Header - authorizationHeaderAccess token will be transmitted in the Authorization header using Bearer schema
- Query
- queryAccess token will be transmitted as query parameters.
- Bearer
Token Sending Methods Authorization Header - authorizationHeaderAccess token will be transmitted in the Authorization header using Bearer schema
- Bearer
Token Sending Methods Query - queryAccess token will be transmitted as query parameters.
- Authorization
Header - authorizationHeaderAccess token will be transmitted in the Authorization header using Bearer schema
- Query
- queryAccess token will be transmitted as query parameters.
- Authorization
Header - authorizationHeaderAccess token will be transmitted in the Authorization header using Bearer schema
- Query
- queryAccess token will be transmitted as query parameters.
- AUTHORIZATION_HEADER
- authorizationHeaderAccess token will be transmitted in the Authorization header using Bearer schema
- QUERY
- queryAccess token will be transmitted as query parameters.
- "authorization
Header" - authorizationHeaderAccess token will be transmitted in the Authorization header using Bearer schema
- "query"
- queryAccess token will be transmitted as query parameters.
ContentFormat, ContentFormatArgs
- Wadl_
xml - wadl-xmlThe contents are inline and Content type is a WADL document.
- Wadl_
link_ json - wadl-link-jsonThe WADL document is hosted on a publicly accessible internet address.
- Swagger_
json - swagger-jsonThe contents are inline and Content Type is a OpenAPI 2.0 JSON Document.
- Swagger_
link_ json - swagger-link-jsonThe OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.
- Wsdl
- wsdlThe contents are inline and the document is a WSDL/Soap document.
- Wsdl_
link - wsdl-linkThe WSDL document is hosted on a publicly accessible internet address.
- Openapi
- openapiThe contents are inline and Content Type is a OpenAPI 3.0 YAML Document.
- Openapi_
json - openapi+jsonThe contents are inline and Content Type is a OpenAPI 3.0 JSON Document.
- Openapi_
link - openapi-linkThe OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.
- Openapi_
json_ link - openapi+json-linkThe OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.
- Graphql_
link - graphql-linkThe GraphQL API endpoint hosted on a publicly accessible internet address.
- Content
Format_Wadl_Xml - wadl-xmlThe contents are inline and Content type is a WADL document.
- Content
Format_Wadl_Link_Json - wadl-link-jsonThe WADL document is hosted on a publicly accessible internet address.
- Content
Format_Swagger_Json - swagger-jsonThe contents are inline and Content Type is a OpenAPI 2.0 JSON Document.
- Content
Format_Swagger_Link_Json - swagger-link-jsonThe OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.
- Content
Format Wsdl - wsdlThe contents are inline and the document is a WSDL/Soap document.
- Content
Format_Wsdl_Link - wsdl-linkThe WSDL document is hosted on a publicly accessible internet address.
- Content
Format Openapi - openapiThe contents are inline and Content Type is a OpenAPI 3.0 YAML Document.
- Content
Format_Openapi_ json - openapi+jsonThe contents are inline and Content Type is a OpenAPI 3.0 JSON Document.
- Content
Format_Openapi_Link - openapi-linkThe OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.
- Content
Format_Openapi_ json_Link - openapi+json-linkThe OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.
- Content
Format_Graphql_Link - graphql-linkThe GraphQL API endpoint hosted on a publicly accessible internet address.
- Wadlxml
- wadl-xmlThe contents are inline and Content type is a WADL document.
- Wadllinkjson
- wadl-link-jsonThe WADL document is hosted on a publicly accessible internet address.
- Swaggerjson
- swagger-jsonThe contents are inline and Content Type is a OpenAPI 2.0 JSON Document.
- Swaggerlinkjson
- swagger-link-jsonThe OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.
- Wsdl
- wsdlThe contents are inline and the document is a WSDL/Soap document.
- Wsdllink
- wsdl-linkThe WSDL document is hosted on a publicly accessible internet address.
- Openapi
- openapiThe contents are inline and Content Type is a OpenAPI 3.0 YAML Document.
- Openapi_
json - openapi+jsonThe contents are inline and Content Type is a OpenAPI 3.0 JSON Document.
- Openapilink
- openapi-linkThe OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.
- Openapi_
jsonlink - openapi+json-linkThe OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.
- Graphqllink
- graphql-linkThe GraphQL API endpoint hosted on a publicly accessible internet address.
- Wadl_
xml - wadl-xmlThe contents are inline and Content type is a WADL document.
- Wadl_
link_ json - wadl-link-jsonThe WADL document is hosted on a publicly accessible internet address.
- Swagger_
json - swagger-jsonThe contents are inline and Content Type is a OpenAPI 2.0 JSON Document.
- Swagger_
link_ json - swagger-link-jsonThe OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.
- Wsdl
- wsdlThe contents are inline and the document is a WSDL/Soap document.
- Wsdl_
link - wsdl-linkThe WSDL document is hosted on a publicly accessible internet address.
- Openapi
- openapiThe contents are inline and Content Type is a OpenAPI 3.0 YAML Document.
- Openapi_
json - openapi+jsonThe contents are inline and Content Type is a OpenAPI 3.0 JSON Document.
- Openapi_
link - openapi-linkThe OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.
- Openapi_
json_ link - openapi+json-linkThe OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.
- Graphql_
link - graphql-linkThe GraphQL API endpoint hosted on a publicly accessible internet address.
- WADL_XML
- wadl-xmlThe contents are inline and Content type is a WADL document.
- WADL_LINK_JSON
- wadl-link-jsonThe WADL document is hosted on a publicly accessible internet address.
- SWAGGER_JSON
- swagger-jsonThe contents are inline and Content Type is a OpenAPI 2.0 JSON Document.
- SWAGGER_LINK_JSON
- swagger-link-jsonThe OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.
- WSDL
- wsdlThe contents are inline and the document is a WSDL/Soap document.
- WSDL_LINK
- wsdl-linkThe WSDL document is hosted on a publicly accessible internet address.
- OPENAPI
- openapiThe contents are inline and Content Type is a OpenAPI 3.0 YAML Document.
- OPENAPI_JSON
- openapi+jsonThe contents are inline and Content Type is a OpenAPI 3.0 JSON Document.
- OPENAPI_LINK
- openapi-linkThe OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.
- OPENAPI_JSON_LINK
- openapi+json-linkThe OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.
- GRAPHQL_LINK
- graphql-linkThe GraphQL API endpoint hosted on a publicly accessible internet address.
- "wadl-xml"
- wadl-xmlThe contents are inline and Content type is a WADL document.
- "wadl-link-json"
- wadl-link-jsonThe WADL document is hosted on a publicly accessible internet address.
- "swagger-json"
- swagger-jsonThe contents are inline and Content Type is a OpenAPI 2.0 JSON Document.
- "swagger-link-json"
- swagger-link-jsonThe OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.
- "wsdl"
- wsdlThe contents are inline and the document is a WSDL/Soap document.
- "wsdl-link"
- wsdl-linkThe WSDL document is hosted on a publicly accessible internet address.
- "openapi"
- openapiThe contents are inline and Content Type is a OpenAPI 3.0 YAML Document.
- "openapi+json"
- openapi+jsonThe contents are inline and Content Type is a OpenAPI 3.0 JSON Document.
- "openapi-link"
- openapi-linkThe OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.
- "openapi+json-link"
- openapi+json-linkThe OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.
- "graphql-link"
- graphql-linkThe GraphQL API endpoint hosted on a publicly accessible internet address.
OAuth2AuthenticationSettingsContract, OAuth2AuthenticationSettingsContractArgs
- string
- OAuth authorization server identifier.
- Scope string
- operations scope.
- string
- OAuth authorization server identifier.
- Scope string
- operations scope.
- String
- OAuth authorization server identifier.
- scope String
- operations scope.
- string
- OAuth authorization server identifier.
- scope string
- operations scope.
- str
- OAuth authorization server identifier.
- scope str
- operations scope.
- String
- OAuth authorization server identifier.
- scope String
- operations scope.
OAuth2AuthenticationSettingsContractResponse, OAuth2AuthenticationSettingsContractResponseArgs
- string
- OAuth authorization server identifier.
- Scope string
- operations scope.
- string
- OAuth authorization server identifier.
- Scope string
- operations scope.
- String
- OAuth authorization server identifier.
- scope String
- operations scope.
- string
- OAuth authorization server identifier.
- scope string
- operations scope.
- str
- OAuth authorization server identifier.
- scope str
- operations scope.
- String
- OAuth authorization server identifier.
- scope String
- operations scope.
OpenIdAuthenticationSettingsContract, OpenIdAuthenticationSettingsContractArgs
- Bearer
Token List<Union<string, Pulumi.Sending Methods Azure Native. Api Management. Bearer Token Sending Methods>> - How to send token to the server.
- Openid
Provider stringId - OAuth authorization server identifier.
- Bearer
Token []stringSending Methods - How to send token to the server.
- Openid
Provider stringId - OAuth authorization server identifier.
- bearer
Token List<Either<String,BearerSending Methods Token Sending Methods>> - How to send token to the server.
- openid
Provider StringId - OAuth authorization server identifier.
- bearer
Token (string | BearerSending Methods Token Sending Methods)[] - How to send token to the server.
- openid
Provider stringId - OAuth authorization server identifier.
- bearer_
token_ Sequence[Union[str, Bearersending_ methods Token Sending Methods]] - How to send token to the server.
- openid_
provider_ strid - OAuth authorization server identifier.
- bearer
Token List<String | "authorizationSending Methods Header" | "query"> - How to send token to the server.
- openid
Provider StringId - OAuth authorization server identifier.
OpenIdAuthenticationSettingsContractResponse, OpenIdAuthenticationSettingsContractResponseArgs
- Bearer
Token List<string>Sending Methods - How to send token to the server.
- Openid
Provider stringId - OAuth authorization server identifier.
- Bearer
Token []stringSending Methods - How to send token to the server.
- Openid
Provider stringId - OAuth authorization server identifier.
- bearer
Token List<String>Sending Methods - How to send token to the server.
- openid
Provider StringId - OAuth authorization server identifier.
- bearer
Token string[]Sending Methods - How to send token to the server.
- openid
Provider stringId - OAuth authorization server identifier.
- bearer_
token_ Sequence[str]sending_ methods - How to send token to the server.
- openid_
provider_ strid - OAuth authorization server identifier.
- bearer
Token List<String>Sending Methods - How to send token to the server.
- openid
Provider StringId - OAuth authorization server identifier.
Protocol, ProtocolArgs
- Http
- http
- Https
- https
- Ws
- ws
- Wss
- wss
- Protocol
Http - http
- Protocol
Https - https
- Protocol
Ws - ws
- Protocol
Wss - wss
- Http
- http
- Https
- https
- Ws
- ws
- Wss
- wss
- Http
- http
- Https
- https
- Ws
- ws
- Wss
- wss
- HTTP
- http
- HTTPS
- https
- WS
- ws
- WSS
- wss
- "http"
- http
- "https"
- https
- "ws"
- ws
- "wss"
- wss
SoapApiType, SoapApiTypeArgs
- Soap
To Rest - httpImports a SOAP API having a RESTful front end.
- Soap
Pass Through - soapImports the SOAP API having a SOAP front end.
- Web
Socket - websocketImports the API having a Websocket front end.
- Graph
QL - graphqlImports the API having a GraphQL front end.
- Soap
Api Type Soap To Rest - httpImports a SOAP API having a RESTful front end.
- Soap
Api Type Soap Pass Through - soapImports the SOAP API having a SOAP front end.
- Soap
Api Type Web Socket - websocketImports the API having a Websocket front end.
- Soap
Api Type Graph QL - graphqlImports the API having a GraphQL front end.
- Soap
To Rest - httpImports a SOAP API having a RESTful front end.
- Soap
Pass Through - soapImports the SOAP API having a SOAP front end.
- Web
Socket - websocketImports the API having a Websocket front end.
- Graph
QL - graphqlImports the API having a GraphQL front end.
- Soap
To Rest - httpImports a SOAP API having a RESTful front end.
- Soap
Pass Through - soapImports the SOAP API having a SOAP front end.
- Web
Socket - websocketImports the API having a Websocket front end.
- Graph
QL - graphqlImports the API having a GraphQL front end.
- SOAP_TO_REST
- httpImports a SOAP API having a RESTful front end.
- SOAP_PASS_THROUGH
- soapImports the SOAP API having a SOAP front end.
- WEB_SOCKET
- websocketImports the API having a Websocket front end.
- GRAPH_QL
- graphqlImports the API having a GraphQL front end.
- "http"
- httpImports a SOAP API having a RESTful front end.
- "soap"
- soapImports the SOAP API having a SOAP front end.
- "websocket"
- websocketImports the API having a Websocket front end.
- "graphql"
- graphqlImports the API having a GraphQL front end.
SubscriptionKeyParameterNamesContract, SubscriptionKeyParameterNamesContractArgs
SubscriptionKeyParameterNamesContractResponse, SubscriptionKeyParameterNamesContractResponseArgs
TranslateRequiredQueryParametersConduct, TranslateRequiredQueryParametersConductArgs
- Template
- templateTranslates required query parameters to template ones. Is a default value
- Query
- queryLeaves required query parameters as they are (no translation done).
- Translate
Required Query Parameters Conduct Template - templateTranslates required query parameters to template ones. Is a default value
- Translate
Required Query Parameters Conduct Query - queryLeaves required query parameters as they are (no translation done).
- Template
- templateTranslates required query parameters to template ones. Is a default value
- Query
- queryLeaves required query parameters as they are (no translation done).
- Template
- templateTranslates required query parameters to template ones. Is a default value
- Query
- queryLeaves required query parameters as they are (no translation done).
- TEMPLATE
- templateTranslates required query parameters to template ones. Is a default value
- QUERY
- queryLeaves required query parameters as they are (no translation done).
- "template"
- templateTranslates required query parameters to template ones. Is a default value
- "query"
- queryLeaves required query parameters as they are (no translation done).
VersioningScheme, VersioningSchemeArgs
- Segment
- SegmentThe API Version is passed in a path segment.
- Query
- QueryThe API Version is passed in a query parameter.
- Header
- HeaderThe API Version is passed in a HTTP header.
- Versioning
Scheme Segment - SegmentThe API Version is passed in a path segment.
- Versioning
Scheme Query - QueryThe API Version is passed in a query parameter.
- Versioning
Scheme Header - HeaderThe API Version is passed in a HTTP header.
- Segment
- SegmentThe API Version is passed in a path segment.
- Query
- QueryThe API Version is passed in a query parameter.
- Header
- HeaderThe API Version is passed in a HTTP header.
- Segment
- SegmentThe API Version is passed in a path segment.
- Query
- QueryThe API Version is passed in a query parameter.
- Header
- HeaderThe API Version is passed in a HTTP header.
- SEGMENT
- SegmentThe API Version is passed in a path segment.
- QUERY
- QueryThe API Version is passed in a query parameter.
- HEADER
- HeaderThe API Version is passed in a HTTP header.
- "Segment"
- SegmentThe API Version is passed in a path segment.
- "Query"
- QueryThe API Version is passed in a query parameter.
- "Header"
- HeaderThe API Version is passed in a HTTP header.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:apimanagement:Api apiid9419 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi