Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. CustomApi
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.8.0 published on Monday, Sep 18, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.web.CustomApi

Explore with Pulumi AI

azure-native logo
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.8.0 published on Monday, Sep 18, 2023 by Pulumi
pulumi/pulumi-azure-native

    A custom API Azure REST API version: 2016-06-01. Prior API version in Azure Native 1.x: 2016-06-01

    Example Usage

    Replace a custom API

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var customApi = new AzureNative.Web.CustomApi("customApi", new()
    {
        ApiName = "testCustomApi",
        Properties = new AzureNative.Web.Inputs.CustomApiPropertiesDefinitionArgs
        {
            ApiDefinitions = new AzureNative.Web.Inputs.ApiResourceDefinitionsArgs
            {
                OriginalSwaggerUrl = "https://tempuri.org/swagger.json",
            },
            ApiType = "Rest",
            Capabilities = new[] {},
            Description = "",
            DisplayName = "testCustomApi",
            IconUri = "/testIcon.svg",
        },
        ResourceGroupName = "testResourceGroup",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-azure-native-sdk/web/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := web.NewCustomApi(ctx, "customApi", &web.CustomApiArgs{
			ApiName: pulumi.String("testCustomApi"),
			Properties: web.CustomApiPropertiesDefinitionResponse{
				ApiDefinitions: &web.ApiResourceDefinitionsArgs{
					OriginalSwaggerUrl: pulumi.String("https://tempuri.org/swagger.json"),
				},
				ApiType:      pulumi.String("Rest"),
				Capabilities: pulumi.StringArray{},
				Description:  pulumi.String(""),
				DisplayName:  pulumi.String("testCustomApi"),
				IconUri:      pulumi.String("/testIcon.svg"),
			},
			ResourceGroupName: pulumi.String("testResourceGroup"),
		})
		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.web.CustomApi;
import com.pulumi.azurenative.web.CustomApiArgs;
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 customApi = new CustomApi("customApi", CustomApiArgs.builder()        
            .apiName("testCustomApi")
            .properties(Map.ofEntries(
                Map.entry("apiDefinitions", Map.of("originalSwaggerUrl", "https://tempuri.org/swagger.json")),
                Map.entry("apiType", "Rest"),
                Map.entry("capabilities", ),
                Map.entry("description", ""),
                Map.entry("displayName", "testCustomApi"),
                Map.entry("iconUri", "/testIcon.svg")
            ))
            .resourceGroupName("testResourceGroup")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

custom_api = azure_native.web.CustomApi("customApi",
    api_name="testCustomApi",
    properties=azure_native.web.CustomApiPropertiesDefinitionResponseArgs(
        api_definitions=azure_native.web.ApiResourceDefinitionsArgs(
            original_swagger_url="https://tempuri.org/swagger.json",
        ),
        api_type="Rest",
        capabilities=[],
        description="",
        display_name="testCustomApi",
        icon_uri="/testIcon.svg",
    ),
    resource_group_name="testResourceGroup")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const customApi = new azure_native.web.CustomApi("customApi", {
    apiName: "testCustomApi",
    properties: {
        apiDefinitions: {
            originalSwaggerUrl: "https://tempuri.org/swagger.json",
        },
        apiType: "Rest",
        capabilities: [],
        description: "",
        displayName: "testCustomApi",
        iconUri: "/testIcon.svg",
    },
    resourceGroupName: "testResourceGroup",
});

    resources:
  customApi:
    type: azure-native:web:CustomApi
    properties:
      apiName: testCustomApi
      properties:
        apiDefinitions:
          originalSwaggerUrl: https://tempuri.org/swagger.json
        apiType: Rest
        capabilities: []
        description:
        displayName: testCustomApi
        iconUri: /testIcon.svg
      resourceGroupName: testResourceGroup

    Create CustomApi Resource

    new CustomApi(name: string, args: CustomApiArgs, opts?: CustomResourceOptions);
    @overload
def CustomApi(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              api_name: Optional[str] = None,
              location: Optional[str] = None,
              properties: Optional[CustomApiPropertiesDefinitionArgs] = None,
              resource_group_name: Optional[str] = None,
              subscription_id: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None)
@overload
def CustomApi(resource_name: str,
              args: CustomApiArgs,
              opts: Optional[ResourceOptions] = None)
    func NewCustomApi(ctx *Context, name string, args CustomApiArgs, opts ...ResourceOption) (*CustomApi, error)
    public CustomApi(string name, CustomApiArgs args, CustomResourceOptions? opts = null)
    public CustomApi(String name, CustomApiArgs args)
public CustomApi(String name, CustomApiArgs args, CustomResourceOptions options)

    type: azure-native:web:CustomApi
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomApiArgs
    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 CustomApiArgs
    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 CustomApiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomApiArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    CustomApi 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 CustomApi resource accepts the following input properties:

    ResourceGroupName string

    The resource group

    ApiName string

    API name

    Location string

    Resource location

    Properties Pulumi.AzureNative.Web.Inputs.CustomApiPropertiesDefinition

    Custom API properties

    SubscriptionId string

    Subscription Id

    Tags Dictionary<string, string>

    Resource tags

    ResourceGroupName string

    The resource group

    ApiName string

    API name

    Location string

    Resource location

    Properties CustomApiPropertiesDefinitionArgs

    Custom API properties

    SubscriptionId string

    Subscription Id

    Tags map[string]string

    Resource tags

    resourceGroupName String

    The resource group

    apiName String

    API name

    location String

    Resource location

    properties CustomApiPropertiesDefinition

    Custom API properties

    subscriptionId String

    Subscription Id

    tags Map<String,String>

    Resource tags

    resourceGroupName string

    The resource group

    apiName string

    API name

    location string

    Resource location

    properties CustomApiPropertiesDefinition

    Custom API properties

    subscriptionId string

    Subscription Id

    tags {[key: string]: string}

    Resource tags

    resource_group_name str

    The resource group

    api_name str

    API name

    location str

    Resource location

    properties CustomApiPropertiesDefinitionArgs

    Custom API properties

    subscription_id str

    Subscription Id

    tags Mapping[str, str]

    Resource tags

    resourceGroupName String

    The resource group

    apiName String

    API name

    location String

    Resource location

    properties Property Map

    Custom API properties

    subscriptionId String

    Subscription Id

    tags Map<String>

    Resource tags

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CustomApi resource produces the following output properties:

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string

    Resource name

    Type string

    Resource type

    Etag string

    Resource ETag

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string

    Resource name

    Type string

    Resource type

    Etag string

    Resource ETag

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    Resource name

    type String

    Resource type

    etag String

    Resource ETag

    id string

    The provider-assigned unique ID for this managed resource.

    name string

    Resource name

    type string

    Resource type

    etag string

    Resource ETag

    id str

    The provider-assigned unique ID for this managed resource.

    name str

    Resource name

    type str

    Resource type

    etag str

    Resource ETag

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    Resource name

    type String

    Resource type

    etag String

    Resource ETag

    Supporting Types

    ApiOAuthSettings, ApiOAuthSettingsArgs

    ClientId string

    Resource provider client id

    ClientSecret string

    Client Secret needed for OAuth

    CustomParameters Dictionary<string, Pulumi.AzureNative.Web.Inputs.ApiOAuthSettingsParameter>

    OAuth parameters key is the name of parameter

    IdentityProvider string

    Identity provider

    Properties object

    Read only properties for this oauth setting.

    RedirectUrl string

    Url

    Scopes List<string>

    OAuth scopes

    ClientId string

    Resource provider client id

    ClientSecret string

    Client Secret needed for OAuth

    CustomParameters map[string]ApiOAuthSettingsParameter

    OAuth parameters key is the name of parameter

    IdentityProvider string

    Identity provider

    Properties interface{}

    Read only properties for this oauth setting.

    RedirectUrl string

    Url

    Scopes []string

    OAuth scopes

    clientId String

    Resource provider client id

    clientSecret String

    Client Secret needed for OAuth

    customParameters Map<String,ApiOAuthSettingsParameter>

    OAuth parameters key is the name of parameter

    identityProvider String

    Identity provider

    properties Object

    Read only properties for this oauth setting.

    redirectUrl String

    Url

    scopes List<String>

    OAuth scopes

    clientId string

    Resource provider client id

    clientSecret string

    Client Secret needed for OAuth

    customParameters {[key: string]: ApiOAuthSettingsParameter}

    OAuth parameters key is the name of parameter

    identityProvider string

    Identity provider

    properties any

    Read only properties for this oauth setting.

    redirectUrl string

    Url

    scopes string[]

    OAuth scopes

    client_id str

    Resource provider client id

    client_secret str

    Client Secret needed for OAuth

    custom_parameters Mapping[str, ApiOAuthSettingsParameter]

    OAuth parameters key is the name of parameter

    identity_provider str

    Identity provider

    properties Any

    Read only properties for this oauth setting.

    redirect_url str

    Url

    scopes Sequence[str]

    OAuth scopes

    clientId String

    Resource provider client id

    clientSecret String

    Client Secret needed for OAuth

    customParameters Map<Property Map>

    OAuth parameters key is the name of parameter

    identityProvider String

    Identity provider

    properties Any

    Read only properties for this oauth setting.

    redirectUrl String

    Url

    scopes List<String>

    OAuth scopes

    ApiOAuthSettingsParameter, ApiOAuthSettingsParameterArgs

    Options object

    Options available to this parameter

    UiDefinition object

    UI definitions per culture as caller can specify the culture

    Value string

    Value of the setting

    Options interface{}

    Options available to this parameter

    UiDefinition interface{}

    UI definitions per culture as caller can specify the culture

    Value string

    Value of the setting

    options Object

    Options available to this parameter

    uiDefinition Object

    UI definitions per culture as caller can specify the culture

    value String

    Value of the setting

    options any

    Options available to this parameter

    uiDefinition any

    UI definitions per culture as caller can specify the culture

    value string

    Value of the setting

    options Any

    Options available to this parameter

    ui_definition Any

    UI definitions per culture as caller can specify the culture

    value str

    Value of the setting

    options Any

    Options available to this parameter

    uiDefinition Any

    UI definitions per culture as caller can specify the culture

    value String

    Value of the setting

    ApiOAuthSettingsParameterResponse, ApiOAuthSettingsParameterResponseArgs

    Options object

    Options available to this parameter

    UiDefinition object

    UI definitions per culture as caller can specify the culture

    Value string

    Value of the setting

    Options interface{}

    Options available to this parameter

    UiDefinition interface{}

    UI definitions per culture as caller can specify the culture

    Value string

    Value of the setting

    options Object

    Options available to this parameter

    uiDefinition Object

    UI definitions per culture as caller can specify the culture

    value String

    Value of the setting

    options any

    Options available to this parameter

    uiDefinition any

    UI definitions per culture as caller can specify the culture

    value string

    Value of the setting

    options Any

    Options available to this parameter

    ui_definition Any

    UI definitions per culture as caller can specify the culture

    value str

    Value of the setting

    options Any

    Options available to this parameter

    uiDefinition Any

    UI definitions per culture as caller can specify the culture

    value String

    Value of the setting

    ApiOAuthSettingsResponse, ApiOAuthSettingsResponseArgs

    ClientId string

    Resource provider client id

    ClientSecret string

    Client Secret needed for OAuth

    CustomParameters Dictionary<string, Pulumi.AzureNative.Web.Inputs.ApiOAuthSettingsParameterResponse>

    OAuth parameters key is the name of parameter

    IdentityProvider string

    Identity provider

    Properties object

    Read only properties for this oauth setting.

    RedirectUrl string

    Url

    Scopes List<string>

    OAuth scopes

    ClientId string

    Resource provider client id

    ClientSecret string

    Client Secret needed for OAuth

    CustomParameters map[string]ApiOAuthSettingsParameterResponse

    OAuth parameters key is the name of parameter

    IdentityProvider string

    Identity provider

    Properties interface{}

    Read only properties for this oauth setting.

    RedirectUrl string

    Url

    Scopes []string

    OAuth scopes

    clientId String

    Resource provider client id

    clientSecret String

    Client Secret needed for OAuth

    customParameters Map<String,ApiOAuthSettingsParameterResponse>

    OAuth parameters key is the name of parameter

    identityProvider String

    Identity provider

    properties Object

    Read only properties for this oauth setting.

    redirectUrl String

    Url

    scopes List<String>

    OAuth scopes

    clientId string

    Resource provider client id

    clientSecret string

    Client Secret needed for OAuth

    customParameters {[key: string]: ApiOAuthSettingsParameterResponse}

    OAuth parameters key is the name of parameter

    identityProvider string

    Identity provider

    properties any

    Read only properties for this oauth setting.

    redirectUrl string

    Url

    scopes string[]

    OAuth scopes

    client_id str

    Resource provider client id

    client_secret str

    Client Secret needed for OAuth

    custom_parameters Mapping[str, ApiOAuthSettingsParameterResponse]

    OAuth parameters key is the name of parameter

    identity_provider str

    Identity provider

    properties Any

    Read only properties for this oauth setting.

    redirect_url str

    Url

    scopes Sequence[str]

    OAuth scopes

    clientId String

    Resource provider client id

    clientSecret String

    Client Secret needed for OAuth

    customParameters Map<Property Map>

    OAuth parameters key is the name of parameter

    identityProvider String

    Identity provider

    properties Any

    Read only properties for this oauth setting.

    redirectUrl String

    Url

    scopes List<String>

    OAuth scopes

    ApiResourceBackendService, ApiResourceBackendServiceArgs

    ServiceUrl string

    The service URL

    ServiceUrl string

    The service URL

    serviceUrl String

    The service URL

    serviceUrl string

    The service URL

    service_url str

    The service URL

    serviceUrl String

    The service URL

    ApiResourceBackendServiceResponse, ApiResourceBackendServiceResponseArgs

    ServiceUrl string

    The service URL

    ServiceUrl string

    The service URL

    serviceUrl String

    The service URL

    serviceUrl string

    The service URL

    service_url str

    The service URL

    serviceUrl String

    The service URL

    ApiResourceDefinitions, ApiResourceDefinitionsArgs

    ModifiedSwaggerUrl string

    The modified swagger URL

    OriginalSwaggerUrl string

    The original swagger URL

    ModifiedSwaggerUrl string

    The modified swagger URL

    OriginalSwaggerUrl string

    The original swagger URL

    modifiedSwaggerUrl String

    The modified swagger URL

    originalSwaggerUrl String

    The original swagger URL

    modifiedSwaggerUrl string

    The modified swagger URL

    originalSwaggerUrl string

    The original swagger URL

    modified_swagger_url str

    The modified swagger URL

    original_swagger_url str

    The original swagger URL

    modifiedSwaggerUrl String

    The modified swagger URL

    originalSwaggerUrl String

    The original swagger URL

    ApiResourceDefinitionsResponse, ApiResourceDefinitionsResponseArgs

    ModifiedSwaggerUrl string

    The modified swagger URL

    OriginalSwaggerUrl string

    The original swagger URL

    ModifiedSwaggerUrl string

    The modified swagger URL

    OriginalSwaggerUrl string

    The original swagger URL

    modifiedSwaggerUrl String

    The modified swagger URL

    originalSwaggerUrl String

    The original swagger URL

    modifiedSwaggerUrl string

    The modified swagger URL

    originalSwaggerUrl string

    The original swagger URL

    modified_swagger_url str

    The modified swagger URL

    original_swagger_url str

    The original swagger URL

    modifiedSwaggerUrl String

    The modified swagger URL

    originalSwaggerUrl String

    The original swagger URL

    ApiType, ApiTypeArgs

    NotSpecified
    NotSpecified
    Rest
    Rest
    Soap
    Soap
    ApiTypeNotSpecified
    NotSpecified
    ApiTypeRest
    Rest
    ApiTypeSoap
    Soap
    NotSpecified
    NotSpecified
    Rest
    Rest
    Soap
    Soap
    NotSpecified
    NotSpecified
    Rest
    Rest
    Soap
    Soap
    NOT_SPECIFIED
    NotSpecified
    REST
    Rest
    SOAP
    Soap
    "NotSpecified"
    NotSpecified
    "Rest"
    Rest
    "Soap"
    Soap

    ConnectionParameter, ConnectionParameterArgs

    OAuthSettings ApiOAuthSettings

    OAuth settings for the connection provider

    Type ConnectionParameterType

    Type of the parameter

    oAuthSettings ApiOAuthSettings

    OAuth settings for the connection provider

    type ConnectionParameterType

    Type of the parameter

    oAuthSettings ApiOAuthSettings

    OAuth settings for the connection provider

    type ConnectionParameterType

    Type of the parameter

    o_auth_settings ApiOAuthSettings

    OAuth settings for the connection provider

    type ConnectionParameterType

    Type of the parameter

    ConnectionParameterResponse, ConnectionParameterResponseArgs

    OAuthSettings Pulumi.AzureNative.Web.Inputs.ApiOAuthSettingsResponse

    OAuth settings for the connection provider

    Type string

    Type of the parameter

    OAuthSettings ApiOAuthSettingsResponse

    OAuth settings for the connection provider

    Type string

    Type of the parameter

    oAuthSettings ApiOAuthSettingsResponse

    OAuth settings for the connection provider

    type String

    Type of the parameter

    oAuthSettings ApiOAuthSettingsResponse

    OAuth settings for the connection provider

    type string

    Type of the parameter

    o_auth_settings ApiOAuthSettingsResponse

    OAuth settings for the connection provider

    type str

    Type of the parameter

    oAuthSettings Property Map

    OAuth settings for the connection provider

    type String

    Type of the parameter

    ConnectionParameterType, ConnectionParameterTypeArgs

    @String
    string
    Securestring
    securestring
    Secureobject
    secureobject
    @Int
    int
    @Bool
    bool
    @Object
    object
    Array
    array
    OauthSetting
    oauthSetting
    Connection
    connection
    ConnectionParameterTypeString
    string
    ConnectionParameterTypeSecurestring
    securestring
    ConnectionParameterTypeSecureobject
    secureobject
    ConnectionParameterTypeInt
    int
    ConnectionParameterTypeBool
    bool
    ConnectionParameterTypeObject
    object
    ConnectionParameterTypeArray
    array
    ConnectionParameterTypeOauthSetting
    oauthSetting
    ConnectionParameterTypeConnection
    connection
    String
    string
    Securestring
    securestring
    Secureobject
    secureobject
    Int_
    int
    Bool
    bool
    Object
    object
    Array
    array
    OauthSetting
    oauthSetting
    Connection
    connection
    String
    string
    Securestring
    securestring
    Secureobject
    secureobject
    Int
    int
    Bool
    bool
    Object
    object
    Array
    array
    OauthSetting
    oauthSetting
    Connection
    connection
    STRING
    string
    SECURESTRING
    securestring
    SECUREOBJECT
    secureobject
    INT
    int
    BOOL
    bool
    OBJECT
    object
    ARRAY
    array
    OAUTH_SETTING
    oauthSetting
    CONNECTION
    connection
    "string"
    string
    "securestring"
    securestring
    "secureobject"
    secureobject
    "int"
    int
    "bool"
    bool
    "object"
    object
    "array"
    array
    "oauthSetting"
    oauthSetting
    "connection"
    connection

    CustomApiPropertiesDefinition, CustomApiPropertiesDefinitionArgs

    ApiDefinitions Pulumi.AzureNative.Web.Inputs.ApiResourceDefinitions

    API Definitions

    ApiType string | Pulumi.AzureNative.Web.ApiType

    The API type

    BackendService Pulumi.AzureNative.Web.Inputs.ApiResourceBackendService

    The API backend service

    BrandColor string

    Brand color

    Capabilities List<string>

    The custom API capabilities

    ConnectionParameters Dictionary<string, Pulumi.AzureNative.Web.Inputs.ConnectionParameter>

    Connection parameters

    Description string

    The custom API description

    DisplayName string

    The display name

    IconUri string

    The icon URI

    RuntimeUrls List<string>

    Runtime URLs

    Swagger object

    The JSON representation of the swagger

    WsdlDefinition Pulumi.AzureNative.Web.Inputs.WsdlDefinition

    The WSDL definition

    ApiDefinitions ApiResourceDefinitions

    API Definitions

    ApiType string | ApiType

    The API type

    BackendService ApiResourceBackendService

    The API backend service

    BrandColor string

    Brand color

    Capabilities []string

    The custom API capabilities

    ConnectionParameters map[string]ConnectionParameter

    Connection parameters

    Description string

    The custom API description

    DisplayName string

    The display name

    IconUri string

    The icon URI

    RuntimeUrls []string

    Runtime URLs

    Swagger interface{}

    The JSON representation of the swagger

    WsdlDefinition WsdlDefinition

    The WSDL definition

    apiDefinitions ApiResourceDefinitions

    API Definitions

    apiType String | ApiType

    The API type

    backendService ApiResourceBackendService

    The API backend service

    brandColor String

    Brand color

    capabilities List<String>

    The custom API capabilities

    connectionParameters Map<String,ConnectionParameter>

    Connection parameters

    description String

    The custom API description

    displayName String

    The display name

    iconUri String

    The icon URI

    runtimeUrls List<String>

    Runtime URLs

    swagger Object

    The JSON representation of the swagger

    wsdlDefinition WsdlDefinition

    The WSDL definition

    apiDefinitions ApiResourceDefinitions

    API Definitions

    apiType string | ApiType

    The API type

    backendService ApiResourceBackendService

    The API backend service

    brandColor string

    Brand color

    capabilities string[]

    The custom API capabilities

    connectionParameters {[key: string]: ConnectionParameter}

    Connection parameters

    description string

    The custom API description

    displayName string

    The display name

    iconUri string

    The icon URI

    runtimeUrls string[]

    Runtime URLs

    swagger any

    The JSON representation of the swagger

    wsdlDefinition WsdlDefinition

    The WSDL definition

    api_definitions ApiResourceDefinitions

    API Definitions

    api_type str | ApiType

    The API type

    backend_service ApiResourceBackendService

    The API backend service

    brand_color str

    Brand color

    capabilities Sequence[str]

    The custom API capabilities

    connection_parameters Mapping[str, ConnectionParameter]

    Connection parameters

    description str

    The custom API description

    display_name str

    The display name

    icon_uri str

    The icon URI

    runtime_urls Sequence[str]

    Runtime URLs

    swagger Any

    The JSON representation of the swagger

    wsdl_definition WsdlDefinition

    The WSDL definition

    apiDefinitions Property Map

    API Definitions

    apiType String | "NotSpecified" | "Rest" | "Soap"

    The API type

    backendService Property Map

    The API backend service

    brandColor String

    Brand color

    capabilities List<String>

    The custom API capabilities

    connectionParameters Map<Property Map>

    Connection parameters

    description String

    The custom API description

    displayName String

    The display name

    iconUri String

    The icon URI

    runtimeUrls List<String>

    Runtime URLs

    swagger Any

    The JSON representation of the swagger

    wsdlDefinition Property Map

    The WSDL definition

    CustomApiPropertiesDefinitionResponse, CustomApiPropertiesDefinitionResponseArgs

    ApiDefinitions Pulumi.AzureNative.Web.Inputs.ApiResourceDefinitionsResponse

    API Definitions

    ApiType string

    The API type

    BackendService Pulumi.AzureNative.Web.Inputs.ApiResourceBackendServiceResponse

    The API backend service

    BrandColor string

    Brand color

    Capabilities List<string>

    The custom API capabilities

    ConnectionParameters Dictionary<string, Pulumi.AzureNative.Web.Inputs.ConnectionParameterResponse>

    Connection parameters

    Description string

    The custom API description

    DisplayName string

    The display name

    IconUri string

    The icon URI

    RuntimeUrls List<string>

    Runtime URLs

    Swagger object

    The JSON representation of the swagger

    WsdlDefinition Pulumi.AzureNative.Web.Inputs.WsdlDefinitionResponse

    The WSDL definition

    ApiDefinitions ApiResourceDefinitionsResponse

    API Definitions

    ApiType string

    The API type

    BackendService ApiResourceBackendServiceResponse

    The API backend service

    BrandColor string

    Brand color

    Capabilities []string

    The custom API capabilities

    ConnectionParameters map[string]ConnectionParameterResponse

    Connection parameters

    Description string

    The custom API description

    DisplayName string

    The display name

    IconUri string

    The icon URI

    RuntimeUrls []string

    Runtime URLs

    Swagger interface{}

    The JSON representation of the swagger

    WsdlDefinition WsdlDefinitionResponse

    The WSDL definition

    apiDefinitions ApiResourceDefinitionsResponse

    API Definitions

    apiType String

    The API type

    backendService ApiResourceBackendServiceResponse

    The API backend service

    brandColor String

    Brand color

    capabilities List<String>

    The custom API capabilities

    connectionParameters Map<String,ConnectionParameterResponse>

    Connection parameters

    description String

    The custom API description

    displayName String

    The display name

    iconUri String

    The icon URI

    runtimeUrls List<String>

    Runtime URLs

    swagger Object

    The JSON representation of the swagger

    wsdlDefinition WsdlDefinitionResponse

    The WSDL definition

    apiDefinitions ApiResourceDefinitionsResponse

    API Definitions

    apiType string

    The API type

    backendService ApiResourceBackendServiceResponse

    The API backend service

    brandColor string

    Brand color

    capabilities string[]

    The custom API capabilities

    connectionParameters {[key: string]: ConnectionParameterResponse}

    Connection parameters

    description string

    The custom API description

    displayName string

    The display name

    iconUri string

    The icon URI

    runtimeUrls string[]

    Runtime URLs

    swagger any

    The JSON representation of the swagger

    wsdlDefinition WsdlDefinitionResponse

    The WSDL definition

    api_definitions ApiResourceDefinitionsResponse

    API Definitions

    api_type str

    The API type

    backend_service ApiResourceBackendServiceResponse

    The API backend service

    brand_color str

    Brand color

    capabilities Sequence[str]

    The custom API capabilities

    connection_parameters Mapping[str, ConnectionParameterResponse]

    Connection parameters

    description str

    The custom API description

    display_name str

    The display name

    icon_uri str

    The icon URI

    runtime_urls Sequence[str]

    Runtime URLs

    swagger Any

    The JSON representation of the swagger

    wsdl_definition WsdlDefinitionResponse

    The WSDL definition

    apiDefinitions Property Map

    API Definitions

    apiType String

    The API type

    backendService Property Map

    The API backend service

    brandColor String

    Brand color

    capabilities List<String>

    The custom API capabilities

    connectionParameters Map<Property Map>

    Connection parameters

    description String

    The custom API description

    displayName String

    The display name

    iconUri String

    The icon URI

    runtimeUrls List<String>

    Runtime URLs

    swagger Any

    The JSON representation of the swagger

    wsdlDefinition Property Map

    The WSDL definition

    WsdlDefinition, WsdlDefinitionArgs

    Content string

    The WSDL content

    ImportMethod string | Pulumi.AzureNative.Web.WsdlImportMethod

    The WSDL import method

    Service Pulumi.AzureNative.Web.Inputs.WsdlService

    The service with name and endpoint names

    Url string

    The WSDL URL

    Content string

    The WSDL content

    ImportMethod string | WsdlImportMethod

    The WSDL import method

    Service WsdlService

    The service with name and endpoint names

    Url string

    The WSDL URL

    content String

    The WSDL content

    importMethod String | WsdlImportMethod

    The WSDL import method

    service WsdlService

    The service with name and endpoint names

    url String

    The WSDL URL

    content string

    The WSDL content

    importMethod string | WsdlImportMethod

    The WSDL import method

    service WsdlService

    The service with name and endpoint names

    url string

    The WSDL URL

    content str

    The WSDL content

    import_method str | WsdlImportMethod

    The WSDL import method

    service WsdlService

    The service with name and endpoint names

    url str

    The WSDL URL

    content String

    The WSDL content

    importMethod String | "NotSpecified" | "SoapToRest" | "SoapPassThrough"

    The WSDL import method

    service Property Map

    The service with name and endpoint names

    url String

    The WSDL URL

    WsdlDefinitionResponse, WsdlDefinitionResponseArgs

    Content string

    The WSDL content

    ImportMethod string

    The WSDL import method

    Service Pulumi.AzureNative.Web.Inputs.WsdlServiceResponse

    The service with name and endpoint names

    Url string

    The WSDL URL

    Content string

    The WSDL content

    ImportMethod string

    The WSDL import method

    Service WsdlServiceResponse

    The service with name and endpoint names

    Url string

    The WSDL URL

    content String

    The WSDL content

    importMethod String

    The WSDL import method

    service WsdlServiceResponse

    The service with name and endpoint names

    url String

    The WSDL URL

    content string

    The WSDL content

    importMethod string

    The WSDL import method

    service WsdlServiceResponse

    The service with name and endpoint names

    url string

    The WSDL URL

    content str

    The WSDL content

    import_method str

    The WSDL import method

    service WsdlServiceResponse

    The service with name and endpoint names

    url str

    The WSDL URL

    content String

    The WSDL content

    importMethod String

    The WSDL import method

    service Property Map

    The service with name and endpoint names

    url String

    The WSDL URL

    WsdlImportMethod, WsdlImportMethodArgs

    NotSpecified
    NotSpecified
    SoapToRest
    SoapToRest
    SoapPassThrough
    SoapPassThrough
    WsdlImportMethodNotSpecified
    NotSpecified
    WsdlImportMethodSoapToRest
    SoapToRest
    WsdlImportMethodSoapPassThrough
    SoapPassThrough
    NotSpecified
    NotSpecified
    SoapToRest
    SoapToRest
    SoapPassThrough
    SoapPassThrough
    NotSpecified
    NotSpecified
    SoapToRest
    SoapToRest
    SoapPassThrough
    SoapPassThrough
    NOT_SPECIFIED
    NotSpecified
    SOAP_TO_REST
    SoapToRest
    SOAP_PASS_THROUGH
    SoapPassThrough
    "NotSpecified"
    NotSpecified
    "SoapToRest"
    SoapToRest
    "SoapPassThrough"
    SoapPassThrough

    WsdlService, WsdlServiceArgs

    QualifiedName string

    The service's qualified name

    EndpointQualifiedNames List<string>

    List of the endpoints' qualified names

    QualifiedName string

    The service's qualified name

    EndpointQualifiedNames []string

    List of the endpoints' qualified names

    qualifiedName String

    The service's qualified name

    endpointQualifiedNames List<String>

    List of the endpoints' qualified names

    qualifiedName string

    The service's qualified name

    endpointQualifiedNames string[]

    List of the endpoints' qualified names

    qualified_name str

    The service's qualified name

    endpoint_qualified_names Sequence[str]

    List of the endpoints' qualified names

    qualifiedName String

    The service's qualified name

    endpointQualifiedNames List<String>

    List of the endpoints' qualified names

    WsdlServiceResponse, WsdlServiceResponseArgs

    QualifiedName string

    The service's qualified name

    EndpointQualifiedNames List<string>

    List of the endpoints' qualified names

    QualifiedName string

    The service's qualified name

    EndpointQualifiedNames []string

    List of the endpoints' qualified names

    qualifiedName String

    The service's qualified name

    endpointQualifiedNames List<String>

    List of the endpoints' qualified names

    qualifiedName string

    The service's qualified name

    endpointQualifiedNames string[]

    List of the endpoints' qualified names

    qualified_name str

    The service's qualified name

    endpoint_qualified_names Sequence[str]

    List of the endpoints' qualified names

    qualifiedName String

    The service's qualified name

    endpointQualifiedNames List<String>

    List of the endpoints' qualified names

    Import

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

    $ pulumi import azure-native:web:CustomApi testCustomApi /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/customApis/{apiName}

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.8.0 published on Monday, Sep 18, 2023 by Pulumi
    pulumi/pulumi-azure-native