Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

Api

Api details. API Version: 2020-12-01.

Example Usage

ApiManagementCreateApi

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var api = new AzureNative.ApiManagement.Api("api", new AzureNative.ApiManagement.ApiArgs
        {
            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 = 
            {
                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/go/azure/apimanagement"
	"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: []apimanagement.Protocol{
				apimanagement.ProtocolHttps,
				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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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(Map.of("oAuth2", Map.ofEntries(
                Map.entry("authorizationServerId", "authorizationServerId2283"),
                Map.entry("scope", "oauth2scope2580")
            )))
            .description("apidescription5200")
            .displayName("apiname1463")
            .path("newapiPath")
            .protocols(            
                "https",
                "http")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .serviceUrl("http://newechoapi.cloudapp.net/api")
            .subscriptionKeyParameterNames(Map.ofEntries(
                Map.entry("header", "header4520"),
                Map.entry("query", "query3037")
            ))
            .build());

        }
}
import pulumi
import pulumi_azure_native as azure_native

api = azure_native.apimanagement.Api("api",
    api_id="tempgroup",
    authentication_settings=azure_native.apimanagement.AuthenticationSettingsContractArgs(
        o_auth2=azure_native.apimanagement.OAuth2AuthenticationSettingsContractArgs(
            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=azure_native.apimanagement.SubscriptionKeyParameterNamesContractArgs(
        header="header4520",
        query="query3037",
    ))
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",
    },
});
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 Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var api = new AzureNative.ApiManagement.Api("api", new AzureNative.ApiManagement.ApiArgs
        {
            ApiId = "echo-api2",
            Description = "Copy of Existing Echo Api including Operations.",
            DisplayName = "Echo API2",
            IsCurrent = true,
            Path = "echo2",
            Protocols = 
            {
                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/go/azure/apimanagement"
	"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: []apimanagement.Protocol{
				apimanagement.ProtocolHttp,
				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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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 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)
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,
});
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 Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var api = new AzureNative.ApiManagement.Api("api", new AzureNative.ApiManagement.ApiArgs
        {
            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 = 
            {
                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/go/azure/apimanagement"
	"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: []apimanagement.Protocol{
				apimanagement.ProtocolHttp,
				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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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 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)
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,
});
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 Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var api = new AzureNative.ApiManagement.Api("api", new AzureNative.ApiManagement.ApiArgs
        {
            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/go/azure/apimanagement"
	"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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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 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")
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",
});
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 Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var api = new AzureNative.ApiManagement.Api("api", new AzureNative.ApiManagement.ApiArgs
        {
            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/go/azure/apimanagement"
	"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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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 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/")
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/",
});
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 Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var api = new AzureNative.ApiManagement.Api("api", new AzureNative.ApiManagement.ApiArgs
        {
            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",
        });
    }

}
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native/sdk/go/azure/apimanagement"
	"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("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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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 pulumi
import pulumi_azure_native as azure_native

api = azure_native.apimanagement.Api("api",
    api_id="petstore",
    format="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")
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: "openapi-link",
    path: "petstore",
    resourceGroupName: "rg1",
    serviceName: "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

ApiManagementCreateApiUsingSwaggerImport

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var api = new AzureNative.ApiManagement.Api("api", new AzureNative.ApiManagement.ApiArgs
        {
            ApiId = "petstore",
            Format = "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/go/azure/apimanagement"
	"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("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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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 pulumi
import pulumi_azure_native as azure_native

api = azure_native.apimanagement.Api("api",
    api_id="petstore",
    format="swagger-link-json",
    path="petstore",
    resource_group_name="rg1",
    service_name="apimService1",
    value="http://petstore.swagger.io/v2/swagger.json")
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: "swagger-link-json",
    path: "petstore",
    resourceGroupName: "rg1",
    serviceName: "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 Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var api = new AzureNative.ApiManagement.Api("api", new AzureNative.ApiManagement.ApiArgs
        {
            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",
        });
    }

}
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native/sdk/go/azure/apimanagement"
	"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("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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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 pulumi
import pulumi_azure_native as azure_native

api = azure_native.apimanagement.Api("api",
    api_id="petstore",
    format="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")
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: "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",
});
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

ApiManagementCreateApiWithOpenIdConnect

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var api = new AzureNative.ApiManagement.Api("api", new AzureNative.ApiManagement.ApiArgs
        {
            ApiId = "tempgroup",
            AuthenticationSettings = new AzureNative.ApiManagement.Inputs.AuthenticationSettingsContractArgs
            {
                Openid = new AzureNative.ApiManagement.Inputs.OpenIdAuthenticationSettingsContractArgs
                {
                    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 = 
            {
                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/go/azure/apimanagement"
	"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("authorizationHeader"),
					},
					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: []apimanagement.Protocol{
				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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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(Map.of("openid", Map.ofEntries(
                Map.entry("bearerTokenSendingMethods", "authorizationHeader"),
                Map.entry("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(Map.ofEntries(
                Map.entry("header", "Ocp-Apim-Subscription-Key"),
                Map.entry("query", "subscription-key")
            ))
            .build());

        }
}
import pulumi
import pulumi_azure_native as azure_native

api = azure_native.apimanagement.Api("api",
    api_id="tempgroup",
    authentication_settings=azure_native.apimanagement.AuthenticationSettingsContractArgs(
        openid=azure_native.apimanagement.OpenIdAuthenticationSettingsContractArgs(
            bearer_token_sending_methods=["authorizationHeader"],
            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=azure_native.apimanagement.SubscriptionKeyParameterNamesContractArgs(
        header="Ocp-Apim-Subscription-Key",
        query="subscription-key",
    ))
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: ["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",
    },
});
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

ApiManagementCreateSoapPassThroughApiUsingWsdlImport

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var api = new AzureNative.ApiManagement.Api("api", new AzureNative.ApiManagement.ApiArgs
        {
            ApiId = "soapApi",
            Format = "wsdl-link",
            Path = "currency",
            ResourceGroupName = "rg1",
            ServiceName = "apimService1",
            SoapApiType = "soap",
            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/go/azure/apimanagement"
	"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("wsdl-link"),
			Path:              pulumi.String("currency"),
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("apimService1"),
			SoapApiType:       pulumi.String("soap"),
			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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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(Map.ofEntries(
                Map.entry("wsdlEndpointName", "CurrencyConvertorSoap"),
                Map.entry("wsdlServiceName", "CurrencyConvertor")
            ))
            .build());

        }
}
import pulumi
import pulumi_azure_native as azure_native

api = azure_native.apimanagement.Api("api",
    api_id="soapApi",
    format="wsdl-link",
    path="currency",
    resource_group_name="rg1",
    service_name="apimService1",
    soap_api_type="soap",
    value="http://www.webservicex.net/CurrencyConvertor.asmx?WSDL",
    wsdl_selector=azure_native.apimanagement.ApiCreateOrUpdatePropertiesWsdlSelectorArgs(
        wsdl_endpoint_name="CurrencyConvertorSoap",
        wsdl_service_name="CurrencyConvertor",
    ))
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: "wsdl-link",
    path: "currency",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    soapApiType: "soap",
    value: "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL",
    wsdlSelector: {
        wsdlEndpointName: "CurrencyConvertorSoap",
        wsdlServiceName: "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 Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var api = new AzureNative.ApiManagement.Api("api", new AzureNative.ApiManagement.ApiArgs
        {
            ApiId = "soapApi",
            Format = "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/go/azure/apimanagement"
	"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("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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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(Map.ofEntries(
                Map.entry("wsdlEndpointName", "CurrencyConvertorSoap"),
                Map.entry("wsdlServiceName", "CurrencyConvertor")
            ))
            .build());

        }
}
import pulumi
import pulumi_azure_native as azure_native

api = azure_native.apimanagement.Api("api",
    api_id="soapApi",
    format="wsdl-link",
    path="currency",
    resource_group_name="rg1",
    service_name="apimService1",
    value="http://www.webservicex.net/CurrencyConvertor.asmx?WSDL",
    wsdl_selector=azure_native.apimanagement.ApiCreateOrUpdatePropertiesWsdlSelectorArgs(
        wsdl_endpoint_name="CurrencyConvertorSoap",
        wsdl_service_name="CurrencyConvertor",
    ))
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: "wsdl-link",
    path: "currency",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    value: "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL",
    wsdlSelector: {
        wsdlEndpointName: "CurrencyConvertorSoap",
        wsdlServiceName: "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

Create a Api Resource

new Api(name: string, args: ApiArgs, opts?: CustomResourceOptions);
@overload
def Api(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        api_id: Optional[str] = None,
        api_revision: Optional[str] = None,
        api_revision_description: Optional[str] = None,
        api_type: Optional[Union[str, ApiType]] = None,
        api_version: Optional[str] = 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,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        format: Optional[Union[str, ContentFormat]] = None,
        is_current: Optional[bool] = None,
        path: Optional[str] = None,
        protocols: Optional[Sequence[Protocol]] = None,
        resource_group_name: Optional[str] = None,
        service_name: 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,
        value: Optional[str] = None,
        wsdl_selector: Optional[ApiCreateOrUpdatePropertiesWsdlSelectorArgs] = None)
@overload
def Api(resource_name: str,
        args: ApiArgs,
        opts: Optional[ResourceOptions] = None)
func NewApi(ctx *Context, name string, args ApiArgs, opts ...ResourceOption) (*Api, error)
public Api(string name, ApiArgs args, CustomResourceOptions? opts = null)
public Api(String name, ApiArgs args)
public Api(String name, ApiArgs args, CustomResourceOptions options)
type: azure-native:apimanagement:Api
properties: # The arguments to resource properties.
options: # 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.
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.

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

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.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

ApiId 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.

ApiRevision string

Describes the Revision of the Api. If no value is provided, default revision 1 is created

ApiRevisionDescription string

Description of the Api Revision.

ApiType string | Pulumi.AzureNative.ApiManagement.ApiType

Type of API.

ApiVersion string

Indicates the Version identifier of the API if the API is versioned

ApiVersionDescription string

Description of the Api Version.

ApiVersionSet Pulumi.AzureNative.ApiManagement.Inputs.ApiVersionSetContractDetailsArgs

Version set details

ApiVersionSetId string

A resource identifier for the related ApiVersionSet.

AuthenticationSettings Pulumi.AzureNative.ApiManagement.Inputs.AuthenticationSettingsContractArgs

Collection of authentication settings included into this API.

Description string

Description of the API. May include HTML formatting tags.

DisplayName string

API name. Must be 1 to 300 characters long.

Format string | Pulumi.AzureNative.ApiManagement.ContentFormat

Format of the Content in which the API is getting imported.

IsCurrent bool

Indicates if API revision is current api revision.

Protocols List<Pulumi.AzureNative.ApiManagement.Protocol>

Describes on which protocols the operations in this API can be invoked.

ServiceUrl string

Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.

SoapApiType string | Pulumi.AzureNative.ApiManagement.SoapApiType

Type of Api to create.

  • http creates a SOAP to REST API
  • soap creates a SOAP pass-through API .
SourceApiId string

API identifier of the source API.

SubscriptionKeyParameterNames Pulumi.AzureNative.ApiManagement.Inputs.SubscriptionKeyParameterNamesContractArgs

Protocols over which API is made available.

SubscriptionRequired bool

Specifies whether an API or Product subscription is required for accessing the API.

Value string

Content value when Importing an API.

WsdlSelector Pulumi.AzureNative.ApiManagement.Inputs.ApiCreateOrUpdatePropertiesWsdlSelectorArgs

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.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

ApiId 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.

ApiRevision string

Describes the Revision of the Api. If no value is provided, default revision 1 is created

ApiRevisionDescription string

Description of the Api Revision.

ApiType string | ApiType

Type of API.

ApiVersion string

Indicates the Version identifier of the API if the API is versioned

ApiVersionDescription string

Description of the Api Version.

ApiVersionSet ApiVersionSetContractDetailsArgs

Version set details

ApiVersionSetId string

A resource identifier for the related ApiVersionSet.

AuthenticationSettings AuthenticationSettingsContractArgs

Collection of authentication settings included into this API.

Description string

Description of the API. May include HTML formatting tags.

DisplayName string

API name. Must be 1 to 300 characters long.

Format string | ContentFormat

Format of the Content in which the API is getting imported.

IsCurrent bool

Indicates if API revision is current api revision.

Protocols []Protocol

Describes on which protocols the operations in this API can be invoked.

ServiceUrl string

Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.

SoapApiType string | SoapApiType

Type of Api to create.

  • http creates a SOAP to REST API
  • soap creates a SOAP pass-through API .
SourceApiId string

API identifier of the source API.

SubscriptionKeyParameterNames SubscriptionKeyParameterNamesContractArgs

Protocols over which API is made available.

SubscriptionRequired bool

Specifies whether an API or Product subscription is required for accessing the API.

Value string

Content value when Importing an API.

WsdlSelector ApiCreateOrUpdatePropertiesWsdlSelectorArgs

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.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

apiId 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.

apiRevision String

Describes the Revision of the Api. If no value is provided, default revision 1 is created

apiRevisionDescription String

Description of the Api Revision.

apiType String | ApiType

Type of API.

apiVersion String

Indicates the Version identifier of the API if the API is versioned

apiVersionDescription String

Description of the Api Version.

apiVersionSet ApiVersionSetContractDetailsArgs

Version set details

apiVersionSetId String

A resource identifier for the related ApiVersionSet.

authenticationSettings AuthenticationSettingsContractArgs

Collection of authentication settings included into this API.

description String

Description of the API. May include HTML formatting tags.

displayName String

API name. Must be 1 to 300 characters long.

format String | ContentFormat

Format of the Content in which the API is getting imported.

isCurrent Boolean

Indicates if API revision is current api revision.

protocols List

Describes on which protocols the operations in this API can be invoked.

serviceUrl String

Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.

soapApiType String | SoapApiType

Type of Api to create.

  • http creates a SOAP to REST API
  • soap creates a SOAP pass-through API .
sourceApiId String

API identifier of the source API.

subscriptionKeyParameterNames SubscriptionKeyParameterNamesContractArgs

Protocols over which API is made available.

subscriptionRequired Boolean

Specifies whether an API or Product subscription is required for accessing the API.

value String

Content value when Importing an API.

wsdlSelector ApiCreateOrUpdatePropertiesWsdlSelectorArgs

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.

resourceGroupName string

The name of the resource group.

serviceName string

The name of the API Management service.

apiId 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.

apiRevision string

Describes the Revision of the Api. If no value is provided, default revision 1 is created

apiRevisionDescription string

Description of the Api Revision.

apiType string | ApiType

Type of API.

apiVersion string

Indicates the Version identifier of the API if the API is versioned

apiVersionDescription string

Description of the Api Version.

apiVersionSet ApiVersionSetContractDetailsArgs

Version set details

apiVersionSetId string

A resource identifier for the related ApiVersionSet.

authenticationSettings AuthenticationSettingsContractArgs

Collection of authentication settings included into this API.

description string

Description of the API. May include HTML formatting tags.

displayName string

API name. Must be 1 to 300 characters long.

format string | ContentFormat

Format of the Content in which the API is getting imported.

isCurrent boolean

Indicates if API revision is current api revision.

protocols Protocol[]

Describes on which protocols the operations in this API can be invoked.

serviceUrl string

Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.

soapApiType string | SoapApiType

Type of Api to create.

  • http creates a SOAP to REST API
  • soap creates a SOAP pass-through API .
sourceApiId string

API identifier of the source API.

subscriptionKeyParameterNames SubscriptionKeyParameterNamesContractArgs

Protocols over which API is made available.

subscriptionRequired boolean

Specifies whether an API or Product subscription is required for accessing the API.

value string

Content value when Importing an API.

wsdlSelector ApiCreateOrUpdatePropertiesWsdlSelectorArgs

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_name str

The name of the resource group.

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_description str

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_description str

Description of the Api Version.

api_version_set ApiVersionSetContractDetailsArgs

Version set details

api_version_set_id str

A resource identifier for the related ApiVersionSet.

authentication_settings AuthenticationSettingsContractArgs

Collection of authentication settings included into this 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 | ContentFormat

Format of the Content in which the API is getting imported.

is_current bool

Indicates if API revision is current api revision.

protocols Sequence[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_type str | SoapApiType

Type of Api to create.

  • http creates a SOAP to REST API
  • soap creates a SOAP pass-through API .
source_api_id str

API identifier of the source API.

subscription_key_parameter_names SubscriptionKeyParameterNamesContractArgs

Protocols over which API is made available.

subscription_required bool

Specifies whether an API or Product subscription is required for accessing the API.

value str

Content value when Importing an API.

wsdl_selector ApiCreateOrUpdatePropertiesWsdlSelectorArgs

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.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

apiId 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.

apiRevision String

Describes the Revision of the Api. If no value is provided, default revision 1 is created

apiRevisionDescription String

Description of the Api Revision.

apiType String | "http" | "soap"

Type of API.

apiVersion String

Indicates the Version identifier of the API if the API is versioned

apiVersionDescription String

Description of the Api Version.

apiVersionSet Property Map

Version set details

apiVersionSetId String

A resource identifier for the related ApiVersionSet.

authenticationSettings Property Map

Collection of authentication settings included into this API.

description String

Description of the API. May include HTML formatting tags.

displayName 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"

Format of the Content in which the API is getting imported.

isCurrent Boolean

Indicates if API revision is current api revision.

protocols List<"http" | "https">

Describes on which protocols the operations in this API can be invoked.

serviceUrl String

Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.

soapApiType String | "http" | "soap"

Type of Api to create.

  • http creates a SOAP to REST API
  • soap creates a SOAP pass-through API .
sourceApiId String

API identifier of the source API.

subscriptionKeyParameterNames Property Map

Protocols over which API is made available.

subscriptionRequired Boolean

Specifies whether an API or Product subscription is required for accessing the API.

value String

Content value when Importing an API.

wsdlSelector 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:

Id string

The provider-assigned unique ID for this managed resource.

IsOnline bool

Indicates if API revision is accessible via the gateway.

Name string

Resource name.

Type string

Resource type for API Management resource.

Id string

The provider-assigned unique ID for this managed resource.

IsOnline bool

Indicates if API revision is accessible via the gateway.

Name string

Resource name.

Type string

Resource type for API Management resource.

id String

The provider-assigned unique ID for this managed resource.

isOnline Boolean

Indicates if API revision is accessible via the gateway.

name String

Resource name.

type String

Resource type for API Management resource.

id string

The provider-assigned unique ID for this managed resource.

isOnline boolean

Indicates if API revision is accessible via the gateway.

name string

Resource name.

type string

Resource type for API Management resource.

id str

The provider-assigned unique ID for this managed resource.

is_online bool

Indicates if API revision is accessible via the gateway.

name str

Resource name.

type str

Resource type for API Management resource.

id String

The provider-assigned unique ID for this managed resource.

isOnline Boolean

Indicates if API revision is accessible via the gateway.

name String

Resource name.

type String

Resource type for API Management resource.

Supporting Types

ApiCreateOrUpdatePropertiesWsdlSelector

WsdlEndpointName string

Name of endpoint(port) to import from WSDL

WsdlServiceName string

Name of service to import from WSDL

WsdlEndpointName string

Name of endpoint(port) to import from WSDL

WsdlServiceName string

Name of service to import from WSDL

wsdlEndpointName String

Name of endpoint(port) to import from WSDL

wsdlServiceName String

Name of service to import from WSDL

wsdlEndpointName string

Name of endpoint(port) to import from WSDL

wsdlServiceName string

Name of service to import from WSDL

wsdl_endpoint_name str

Name of endpoint(port) to import from WSDL

wsdl_service_name str

Name of service to import from WSDL

wsdlEndpointName String

Name of endpoint(port) to import from WSDL

wsdlServiceName String

Name of service to import from WSDL

ApiType

Http
http
Soap
soap
ApiTypeHttp
http
ApiTypeSoap
soap
Http
http
Soap
soap
Http
http
Soap
soap
HTTP
http
SOAP
soap
"http"
http
"soap"
soap

ApiVersionSetContractDetails

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.

VersionHeaderName string

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

VersionQueryName string

Name of query parameter that indicates the API Version if versioningScheme is set to query.

VersioningScheme 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.

VersionHeaderName string

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

VersionQueryName string

Name of query parameter that indicates the API Version if versioningScheme is set to query.

VersioningScheme 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.

versionHeaderName String

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

versionQueryName String

Name of query parameter that indicates the API Version if versioningScheme is set to query.

versioningScheme 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.

versionHeaderName string

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

versionQueryName string

Name of query parameter that indicates the API Version if versioningScheme is set to query.

versioningScheme 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_name str

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

version_query_name str

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.

versionHeaderName String

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

versionQueryName String

Name of query parameter that indicates the API Version if versioningScheme is set to query.

versioningScheme String

An value that determines where the API Version identifier will be located in a HTTP request.

ApiVersionSetContractDetailsResponse

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.

VersionHeaderName string

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

VersionQueryName string

Name of query parameter that indicates the API Version if versioningScheme is set to query.

VersioningScheme 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.

VersionHeaderName string

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

VersionQueryName string

Name of query parameter that indicates the API Version if versioningScheme is set to query.

VersioningScheme 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.

versionHeaderName String

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

versionQueryName String

Name of query parameter that indicates the API Version if versioningScheme is set to query.

versioningScheme 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.

versionHeaderName string

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

versionQueryName string

Name of query parameter that indicates the API Version if versioningScheme is set to query.

versioningScheme 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_name str

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

version_query_name str

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.

versionHeaderName String

Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

versionQueryName String

Name of query parameter that indicates the API Version if versioningScheme is set to query.

versioningScheme String

An value that determines where the API Version identifier will be located in a HTTP request.

AuthenticationSettingsContract

OAuth2 OAuth2AuthenticationSettingsContract

OAuth2 Authentication settings

Openid OpenIdAuthenticationSettingsContract

OpenID Connect Authentication Settings

oAuth2 OAuth2AuthenticationSettingsContract

OAuth2 Authentication settings

openid OpenIdAuthenticationSettingsContract

OpenID Connect Authentication Settings

oAuth2 OAuth2AuthenticationSettingsContract

OAuth2 Authentication settings

openid OpenIdAuthenticationSettingsContract

OpenID Connect Authentication Settings

o_auth2 OAuth2AuthenticationSettingsContract

OAuth2 Authentication settings

openid OpenIdAuthenticationSettingsContract

OpenID Connect Authentication Settings

oAuth2 Property Map

OAuth2 Authentication settings

openid Property Map

OpenID Connect Authentication Settings

AuthenticationSettingsContractResponse

OAuth2 OAuth2AuthenticationSettingsContractResponse

OAuth2 Authentication settings

Openid OpenIdAuthenticationSettingsContractResponse

OpenID Connect Authentication Settings

oAuth2 OAuth2AuthenticationSettingsContractResponse

OAuth2 Authentication settings

openid OpenIdAuthenticationSettingsContractResponse

OpenID Connect Authentication Settings

oAuth2 OAuth2AuthenticationSettingsContractResponse

OAuth2 Authentication settings

openid OpenIdAuthenticationSettingsContractResponse

OpenID Connect Authentication Settings

o_auth2 OAuth2AuthenticationSettingsContractResponse

OAuth2 Authentication settings

openid OpenIdAuthenticationSettingsContractResponse

OpenID Connect Authentication Settings

oAuth2 Property Map

OAuth2 Authentication settings

openid Property Map

OpenID Connect Authentication Settings

BearerTokenSendingMethods

AuthorizationHeader
authorizationHeader

Access token will be transmitted in the Authorization header using Bearer schema

Query
query

Access token will be transmitted as query parameters.

BearerTokenSendingMethodsAuthorizationHeader
authorizationHeader

Access token will be transmitted in the Authorization header using Bearer schema

BearerTokenSendingMethodsQuery
query

Access token will be transmitted as query parameters.

AuthorizationHeader
authorizationHeader

Access token will be transmitted in the Authorization header using Bearer schema

Query
query

Access token will be transmitted as query parameters.

AuthorizationHeader
authorizationHeader

Access token will be transmitted in the Authorization header using Bearer schema

Query
query

Access token will be transmitted as query parameters.

AUTHORIZATION_HEADER
authorizationHeader

Access token will be transmitted in the Authorization header using Bearer schema

QUERY
query

Access token will be transmitted as query parameters.

"authorizationHeader"
authorizationHeader

Access token will be transmitted in the Authorization header using Bearer schema

"query"
query

Access token will be transmitted as query parameters.

ContentFormat

Wadl_xml
wadl-xml

The contents are inline and Content type is a WADL document.

Wadl_link_json
wadl-link-json

The WADL document is hosted on a publicly accessible internet address.

Swagger_json
swagger-json

The contents are inline and Content Type is a OpenAPI 2.0 JSON Document.

Swagger_link_json
swagger-link-json

The OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.

Wsdl
wsdl

The contents are inline and the document is a WSDL/Soap document.

Wsdl_link
wsdl-link

The WSDL document is hosted on a publicly accessible internet address.

Openapi
openapi

The contents are inline and Content Type is a OpenAPI 3.0 YAML Document.

Openapi_json
openapi+json

The contents are inline and Content Type is a OpenAPI 3.0 JSON Document.

Openapi_link
openapi-link

The OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.

Openapi_json_link
openapi+json-link

The OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.

ContentFormat_Wadl_xml
wadl-xml

The contents are inline and Content type is a WADL document.

ContentFormat_Wadl_link_json
wadl-link-json

The WADL document is hosted on a publicly accessible internet address.

ContentFormat_Swagger_json
swagger-json

The contents are inline and Content Type is a OpenAPI 2.0 JSON Document.

ContentFormat_Swagger_link_json
swagger-link-json

The OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.

ContentFormatWsdl
wsdl

The contents are inline and the document is a WSDL/Soap document.

ContentFormat_Wsdl_link
wsdl-link

The WSDL document is hosted on a publicly accessible internet address.

ContentFormatOpenapi
openapi

The contents are inline and Content Type is a OpenAPI 3.0 YAML Document.

ContentFormat_Openapi_json
openapi+json

The contents are inline and Content Type is a OpenAPI 3.0 JSON Document.

ContentFormat_Openapi_link
openapi-link

The OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.

ContentFormat_Openapi_json_link
openapi+json-link

The OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.

Wadlxml
wadl-xml

The contents are inline and Content type is a WADL document.

Wadllinkjson
wadl-link-json

The WADL document is hosted on a publicly accessible internet address.

Swaggerjson
swagger-json

The contents are inline and Content Type is a OpenAPI 2.0 JSON Document.

Swaggerlinkjson
swagger-link-json

The OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.

Wsdl
wsdl

The contents are inline and the document is a WSDL/Soap document.

Wsdllink
wsdl-link

The WSDL document is hosted on a publicly accessible internet address.

Openapi
openapi

The contents are inline and Content Type is a OpenAPI 3.0 YAML Document.

Openapi_json
openapi+json

The contents are inline and Content Type is a OpenAPI 3.0 JSON Document.

Openapilink
openapi-link

The OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.

Openapi_jsonlink
openapi+json-link

The OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.

Wadl_xml
wadl-xml

The contents are inline and Content type is a WADL document.

Wadl_link_json
wadl-link-json

The WADL document is hosted on a publicly accessible internet address.

Swagger_json
swagger-json

The contents are inline and Content Type is a OpenAPI 2.0 JSON Document.

Swagger_link_json
swagger-link-json

The OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.

Wsdl
wsdl

The contents are inline and the document is a WSDL/Soap document.

Wsdl_link
wsdl-link

The WSDL document is hosted on a publicly accessible internet address.

Openapi
openapi

The contents are inline and Content Type is a OpenAPI 3.0 YAML Document.

Openapi_json
openapi+json

The contents are inline and Content Type is a OpenAPI 3.0 JSON Document.

Openapi_link
openapi-link

The OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.

Openapi_json_link
openapi+json-link

The OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.

WADL_XML
wadl-xml

The contents are inline and Content type is a WADL document.

WADL_LINK_JSON
wadl-link-json

The WADL document is hosted on a publicly accessible internet address.

SWAGGER_JSON
swagger-json

The contents are inline and Content Type is a OpenAPI 2.0 JSON Document.

SWAGGER_LINK_JSON
swagger-link-json

The OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.

WSDL
wsdl

The contents are inline and the document is a WSDL/Soap document.

WSDL_LINK
wsdl-link

The WSDL document is hosted on a publicly accessible internet address.

OPENAPI
openapi

The contents are inline and Content Type is a OpenAPI 3.0 YAML Document.

OPENAPI_JSON
openapi+json

The contents are inline and Content Type is a OpenAPI 3.0 JSON Document.

OPENAPI_LINK
openapi-link

The OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.

OPENAPI_JSON_LINK
openapi+json-link

The OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.

"wadl-xml"
wadl-xml

The contents are inline and Content type is a WADL document.

"wadl-link-json"
wadl-link-json

The WADL document is hosted on a publicly accessible internet address.

"swagger-json"
swagger-json

The contents are inline and Content Type is a OpenAPI 2.0 JSON Document.

"swagger-link-json"
swagger-link-json

The OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.

"wsdl"
wsdl

The contents are inline and the document is a WSDL/Soap document.

"wsdl-link"
wsdl-link

The WSDL document is hosted on a publicly accessible internet address.

"openapi"
openapi

The contents are inline and Content Type is a OpenAPI 3.0 YAML Document.

"openapi+json"
openapi+json

The contents are inline and Content Type is a OpenAPI 3.0 JSON Document.

"openapi-link"
openapi-link

The OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.

"openapi+json-link"
openapi+json-link

The OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.

OAuth2AuthenticationSettingsContract

AuthorizationServerId string

OAuth authorization server identifier.

Scope string

operations scope.

AuthorizationServerId string

OAuth authorization server identifier.

Scope string

operations scope.

authorizationServerId String

OAuth authorization server identifier.

scope String

operations scope.

authorizationServerId string

OAuth authorization server identifier.

scope string

operations scope.

authorization_server_id str

OAuth authorization server identifier.

scope str

operations scope.

authorizationServerId String

OAuth authorization server identifier.

scope String

operations scope.

OAuth2AuthenticationSettingsContractResponse

AuthorizationServerId string

OAuth authorization server identifier.

Scope string

operations scope.

AuthorizationServerId string

OAuth authorization server identifier.

Scope string

operations scope.

authorizationServerId String

OAuth authorization server identifier.

scope String

operations scope.

authorizationServerId string

OAuth authorization server identifier.

scope string

operations scope.

authorization_server_id str

OAuth authorization server identifier.

scope str

operations scope.

authorizationServerId String

OAuth authorization server identifier.

scope String

operations scope.

OpenIdAuthenticationSettingsContract

BearerTokenSendingMethods List<Union<string, Pulumi.AzureNative.ApiManagement.BearerTokenSendingMethods>>

How to send token to the server.

OpenidProviderId string

OAuth authorization server identifier.

BearerTokenSendingMethods []string

How to send token to the server.

OpenidProviderId string

OAuth authorization server identifier.

bearerTokenSendingMethods ListTokenSendingMethods>>

How to send token to the server.

openidProviderId String

OAuth authorization server identifier.

bearerTokenSendingMethods (string | BearerTokenSendingMethods)[]

How to send token to the server.

openidProviderId string

OAuth authorization server identifier.

bearer_token_sending_methods Sequence[Union[str, BearerTokenSendingMethods]]

How to send token to the server.

openid_provider_id str

OAuth authorization server identifier.

bearerTokenSendingMethods ListHeader" | "query">

How to send token to the server.

openidProviderId String

OAuth authorization server identifier.

OpenIdAuthenticationSettingsContractResponse

BearerTokenSendingMethods List<string>

How to send token to the server.

OpenidProviderId string

OAuth authorization server identifier.

BearerTokenSendingMethods []string

How to send token to the server.

OpenidProviderId string

OAuth authorization server identifier.

bearerTokenSendingMethods List

How to send token to the server.

openidProviderId String

OAuth authorization server identifier.

bearerTokenSendingMethods string[]

How to send token to the server.

openidProviderId string

OAuth authorization server identifier.

bearer_token_sending_methods Sequence[str]

How to send token to the server.

openid_provider_id str

OAuth authorization server identifier.

bearerTokenSendingMethods List

How to send token to the server.

openidProviderId String

OAuth authorization server identifier.

Protocol

Http
http
Https
https
ProtocolHttp
http
ProtocolHttps
https
Http
http
Https
https
Http
http
Https
https
HTTP
http
HTTPS
https
"http"
http
"https"
https

SoapApiType

SoapToRest
http

Imports a SOAP API having a RESTful front end.

SoapPassThrough
soap

Imports the Soap API having a SOAP front end.

SoapApiTypeSoapToRest
http

Imports a SOAP API having a RESTful front end.

SoapApiTypeSoapPassThrough
soap

Imports the Soap API having a SOAP front end.

SoapToRest
http

Imports a SOAP API having a RESTful front end.

SoapPassThrough
soap

Imports the Soap API having a SOAP front end.

SoapToRest
http

Imports a SOAP API having a RESTful front end.

SoapPassThrough
soap

Imports the Soap API having a SOAP front end.

SOAP_TO_REST
http

Imports a SOAP API having a RESTful front end.

SOAP_PASS_THROUGH
soap

Imports the Soap API having a SOAP front end.

"http"
http

Imports a SOAP API having a RESTful front end.

"soap"
soap

Imports the Soap API having a SOAP front end.

SubscriptionKeyParameterNamesContract

Header string

Subscription key header name.

Query string

Subscription key query string parameter name.

Header string

Subscription key header name.

Query string

Subscription key query string parameter name.

header String

Subscription key header name.

query String

Subscription key query string parameter name.

header string

Subscription key header name.

query string

Subscription key query string parameter name.

header str

Subscription key header name.

query str

Subscription key query string parameter name.

header String

Subscription key header name.

query String

Subscription key query string parameter name.

SubscriptionKeyParameterNamesContractResponse

Header string

Subscription key header name.

Query string

Subscription key query string parameter name.

Header string

Subscription key header name.

Query string

Subscription key query string parameter name.

header String

Subscription key header name.

query String

Subscription key query string parameter name.

header string

Subscription key header name.

query string

Subscription key query string parameter name.

header str

Subscription key header name.

query str

Subscription key query string parameter name.

header String

Subscription key header name.

query String

Subscription key query string parameter name.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apimanagement:Api soapApi /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/soapApi 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0