Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. WorkspaceApi
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.WorkspaceApi

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

API details.

Uses Azure REST API version 2022-09-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-09-01-preview.

Other available API versions: 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the version guide for details.

Example Usage

ApiManagementCreateWorkspaceApi

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

return await Deployment.RunAsync(() => 
{
    var workspaceApi = new AzureNative.ApiManagement.WorkspaceApi("workspaceApi", new()
    {
        ApiId = "tempgroup",
        AuthenticationSettings = new AzureNative.ApiManagement.Inputs.AuthenticationSettingsContractArgs
        {
            OAuth2 = new AzureNative.ApiManagement.Inputs.OAuth2AuthenticationSettingsContractArgs
            {
                AuthorizationServerId = "authorizationServerId2283",
                Scope = "oauth2scope2580",
            },
        },
        Description = "apidescription5200",
        DisplayName = "apiname1463",
        Path = "newapiPath",
        Protocols = new[]
        {
            AzureNative.ApiManagement.Protocol.Https,
            AzureNative.ApiManagement.Protocol.Http,
        },
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
        ServiceUrl = "http://newechoapi.cloudapp.net/api",
        SubscriptionKeyParameterNames = new AzureNative.ApiManagement.Inputs.SubscriptionKeyParameterNamesContractArgs
        {
            Header = "header4520",
            Query = "query3037",
        },
        WorkspaceId = "wks1",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewWorkspaceApi(ctx, "workspaceApi", &apimanagement.WorkspaceApiArgs{
			ApiId: pulumi.String("tempgroup"),
			AuthenticationSettings: &apimanagement.AuthenticationSettingsContractArgs{
				OAuth2: &apimanagement.OAuth2AuthenticationSettingsContractArgs{
					AuthorizationServerId: pulumi.String("authorizationServerId2283"),
					Scope:                 pulumi.String("oauth2scope2580"),
				},
			},
			Description: pulumi.String("apidescription5200"),
			DisplayName: pulumi.String("apiname1463"),
			Path:        pulumi.String("newapiPath"),
			Protocols: pulumi.StringArray{
				pulumi.String(apimanagement.ProtocolHttps),
				pulumi.String(apimanagement.ProtocolHttp),
			},
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("apimService1"),
			ServiceUrl:        pulumi.String("http://newechoapi.cloudapp.net/api"),
			SubscriptionKeyParameterNames: &apimanagement.SubscriptionKeyParameterNamesContractArgs{
				Header: pulumi.String("header4520"),
				Query:  pulumi.String("query3037"),
			},
			WorkspaceId: pulumi.String("wks1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.WorkspaceApi;
import com.pulumi.azurenative.apimanagement.WorkspaceApiArgs;
import com.pulumi.azurenative.apimanagement.inputs.AuthenticationSettingsContractArgs;
import com.pulumi.azurenative.apimanagement.inputs.OAuth2AuthenticationSettingsContractArgs;
import com.pulumi.azurenative.apimanagement.inputs.SubscriptionKeyParameterNamesContractArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var workspaceApi = new WorkspaceApi("workspaceApi", WorkspaceApiArgs.builder()
            .apiId("tempgroup")
            .authenticationSettings(AuthenticationSettingsContractArgs.builder()
                .oAuth2(OAuth2AuthenticationSettingsContractArgs.builder()
                    .authorizationServerId("authorizationServerId2283")
                    .scope("oauth2scope2580")
                    .build())
                .build())
            .description("apidescription5200")
            .displayName("apiname1463")
            .path("newapiPath")
            .protocols(            
                "https",
                "http")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .serviceUrl("http://newechoapi.cloudapp.net/api")
            .subscriptionKeyParameterNames(SubscriptionKeyParameterNamesContractArgs.builder()
                .header("header4520")
                .query("query3037")
                .build())
            .workspaceId("wks1")
            .build());

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

const workspaceApi = new azure_native.apimanagement.WorkspaceApi("workspaceApi", {
    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",
    },
    workspaceId: "wks1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

workspace_api = azure_native.apimanagement.WorkspaceApi("workspaceApi",
    api_id="tempgroup",
    authentication_settings={
        "o_auth2": {
            "authorization_server_id": "authorizationServerId2283",
            "scope": "oauth2scope2580",
        },
    },
    description="apidescription5200",
    display_name="apiname1463",
    path="newapiPath",
    protocols=[
        azure_native.apimanagement.Protocol.HTTPS,
        azure_native.apimanagement.Protocol.HTTP,
    ],
    resource_group_name="rg1",
    service_name="apimService1",
    service_url="http://newechoapi.cloudapp.net/api",
    subscription_key_parameter_names={
        "header": "header4520",
        "query": "query3037",
    },
    workspace_id="wks1")
Copy
resources:
  workspaceApi:
    type: azure-native:apimanagement:WorkspaceApi
    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
      workspaceId: wks1
Copy

Create WorkspaceApi Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new WorkspaceApi(name: string, args: WorkspaceApiArgs, opts?: CustomResourceOptions);
@overload
def WorkspaceApi(resource_name: str,
                 args: WorkspaceApiArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def WorkspaceApi(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 path: Optional[str] = None,
                 workspace_id: Optional[str] = None,
                 service_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 license: Optional[ApiLicenseInformationArgs] = None,
                 api_type: Optional[Union[str, ApiType]] = None,
                 api_version_set: Optional[ApiVersionSetContractDetailsArgs] = None,
                 api_version_set_id: Optional[str] = None,
                 authentication_settings: Optional[AuthenticationSettingsContractArgs] = None,
                 contact: Optional[ApiContactInformationArgs] = None,
                 description: Optional[str] = None,
                 display_name: Optional[str] = None,
                 format: Optional[Union[str, ContentFormat]] = None,
                 is_current: Optional[bool] = None,
                 api_id: Optional[str] = None,
                 api_version: Optional[str] = None,
                 protocols: Optional[Sequence[Union[str, Protocol]]] = None,
                 api_version_description: Optional[str] = None,
                 api_revision_description: Optional[str] = None,
                 service_url: Optional[str] = None,
                 soap_api_type: Optional[Union[str, SoapApiType]] = None,
                 source_api_id: Optional[str] = None,
                 subscription_key_parameter_names: Optional[SubscriptionKeyParameterNamesContractArgs] = None,
                 subscription_required: Optional[bool] = None,
                 terms_of_service_url: Optional[str] = None,
                 translate_required_query_parameters_conduct: Optional[Union[str, TranslateRequiredQueryParametersConduct]] = None,
                 value: Optional[str] = None,
                 api_revision: Optional[str] = None,
                 wsdl_selector: Optional[ApiCreateOrUpdatePropertiesWsdlSelectorArgs] = None)
func NewWorkspaceApi(ctx *Context, name string, args WorkspaceApiArgs, opts ...ResourceOption) (*WorkspaceApi, error)
public WorkspaceApi(string name, WorkspaceApiArgs args, CustomResourceOptions? opts = null)
public WorkspaceApi(String name, WorkspaceApiArgs args)
public WorkspaceApi(String name, WorkspaceApiArgs args, CustomResourceOptions options)

type: azure-native:apimanagement:WorkspaceApi
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceApiArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WorkspaceApiArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceApiArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceApiArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WorkspaceApiArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var workspaceApiResource = new AzureNative.ApiManagement.WorkspaceApi("workspaceApiResource", new()
{
    Path = "string",
    WorkspaceId = "string",
    ServiceName = "string",
    ResourceGroupName = "string",
    License = new AzureNative.ApiManagement.Inputs.ApiLicenseInformationArgs
    {
        Name = "string",
        Url = "string",
    },
    ApiType = "string",
    ApiVersionSet = new AzureNative.ApiManagement.Inputs.ApiVersionSetContractDetailsArgs
    {
        Description = "string",
        Id = "string",
        Name = "string",
        VersionHeaderName = "string",
        VersionQueryName = "string",
        VersioningScheme = "string",
    },
    ApiVersionSetId = "string",
    AuthenticationSettings = new AzureNative.ApiManagement.Inputs.AuthenticationSettingsContractArgs
    {
        OAuth2 = new AzureNative.ApiManagement.Inputs.OAuth2AuthenticationSettingsContractArgs
        {
            AuthorizationServerId = "string",
            Scope = "string",
        },
        OAuth2AuthenticationSettings = new[]
        {
            new AzureNative.ApiManagement.Inputs.OAuth2AuthenticationSettingsContractArgs
            {
                AuthorizationServerId = "string",
                Scope = "string",
            },
        },
        Openid = new AzureNative.ApiManagement.Inputs.OpenIdAuthenticationSettingsContractArgs
        {
            BearerTokenSendingMethods = new[]
            {
                "string",
            },
            OpenidProviderId = "string",
        },
        OpenidAuthenticationSettings = new[]
        {
            new AzureNative.ApiManagement.Inputs.OpenIdAuthenticationSettingsContractArgs
            {
                BearerTokenSendingMethods = new[]
                {
                    "string",
                },
                OpenidProviderId = "string",
            },
        },
    },
    Contact = new AzureNative.ApiManagement.Inputs.ApiContactInformationArgs
    {
        Email = "string",
        Name = "string",
        Url = "string",
    },
    Description = "string",
    DisplayName = "string",
    Format = "string",
    IsCurrent = false,
    ApiId = "string",
    ApiVersion = "string",
    Protocols = new[]
    {
        "string",
    },
    ApiVersionDescription = "string",
    ApiRevisionDescription = "string",
    ServiceUrl = "string",
    SoapApiType = "string",
    SourceApiId = "string",
    SubscriptionKeyParameterNames = new AzureNative.ApiManagement.Inputs.SubscriptionKeyParameterNamesContractArgs
    {
        Header = "string",
        Query = "string",
    },
    SubscriptionRequired = false,
    TermsOfServiceUrl = "string",
    TranslateRequiredQueryParametersConduct = "string",
    Value = "string",
    ApiRevision = "string",
    WsdlSelector = new AzureNative.ApiManagement.Inputs.ApiCreateOrUpdatePropertiesWsdlSelectorArgs
    {
        WsdlEndpointName = "string",
        WsdlServiceName = "string",
    },
});
Copy
example, err := apimanagement.NewWorkspaceApi(ctx, "workspaceApiResource", &apimanagement.WorkspaceApiArgs{
	Path:              pulumi.String("string"),
	WorkspaceId:       pulumi.String("string"),
	ServiceName:       pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	License: &apimanagement.ApiLicenseInformationArgs{
		Name: pulumi.String("string"),
		Url:  pulumi.String("string"),
	},
	ApiType: pulumi.String("string"),
	ApiVersionSet: &apimanagement.ApiVersionSetContractDetailsArgs{
		Description:       pulumi.String("string"),
		Id:                pulumi.String("string"),
		Name:              pulumi.String("string"),
		VersionHeaderName: pulumi.String("string"),
		VersionQueryName:  pulumi.String("string"),
		VersioningScheme:  pulumi.String("string"),
	},
	ApiVersionSetId: pulumi.String("string"),
	AuthenticationSettings: &apimanagement.AuthenticationSettingsContractArgs{
		OAuth2: &apimanagement.OAuth2AuthenticationSettingsContractArgs{
			AuthorizationServerId: pulumi.String("string"),
			Scope:                 pulumi.String("string"),
		},
		OAuth2AuthenticationSettings: apimanagement.OAuth2AuthenticationSettingsContractArray{
			&apimanagement.OAuth2AuthenticationSettingsContractArgs{
				AuthorizationServerId: pulumi.String("string"),
				Scope:                 pulumi.String("string"),
			},
		},
		Openid: &apimanagement.OpenIdAuthenticationSettingsContractArgs{
			BearerTokenSendingMethods: pulumi.StringArray{
				pulumi.String("string"),
			},
			OpenidProviderId: pulumi.String("string"),
		},
		OpenidAuthenticationSettings: apimanagement.OpenIdAuthenticationSettingsContractArray{
			&apimanagement.OpenIdAuthenticationSettingsContractArgs{
				BearerTokenSendingMethods: pulumi.StringArray{
					pulumi.String("string"),
				},
				OpenidProviderId: pulumi.String("string"),
			},
		},
	},
	Contact: &apimanagement.ApiContactInformationArgs{
		Email: pulumi.String("string"),
		Name:  pulumi.String("string"),
		Url:   pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Format:      pulumi.String("string"),
	IsCurrent:   pulumi.Bool(false),
	ApiId:       pulumi.String("string"),
	ApiVersion:  pulumi.String("string"),
	Protocols: pulumi.StringArray{
		pulumi.String("string"),
	},
	ApiVersionDescription:  pulumi.String("string"),
	ApiRevisionDescription: pulumi.String("string"),
	ServiceUrl:             pulumi.String("string"),
	SoapApiType:            pulumi.String("string"),
	SourceApiId:            pulumi.String("string"),
	SubscriptionKeyParameterNames: &apimanagement.SubscriptionKeyParameterNamesContractArgs{
		Header: pulumi.String("string"),
		Query:  pulumi.String("string"),
	},
	SubscriptionRequired:                    pulumi.Bool(false),
	TermsOfServiceUrl:                       pulumi.String("string"),
	TranslateRequiredQueryParametersConduct: pulumi.String("string"),
	Value:                                   pulumi.String("string"),
	ApiRevision:                             pulumi.String("string"),
	WsdlSelector: &apimanagement.ApiCreateOrUpdatePropertiesWsdlSelectorArgs{
		WsdlEndpointName: pulumi.String("string"),
		WsdlServiceName:  pulumi.String("string"),
	},
})
Copy
var workspaceApiResource = new WorkspaceApi("workspaceApiResource", WorkspaceApiArgs.builder()
    .path("string")
    .workspaceId("string")
    .serviceName("string")
    .resourceGroupName("string")
    .license(ApiLicenseInformationArgs.builder()
        .name("string")
        .url("string")
        .build())
    .apiType("string")
    .apiVersionSet(ApiVersionSetContractDetailsArgs.builder()
        .description("string")
        .id("string")
        .name("string")
        .versionHeaderName("string")
        .versionQueryName("string")
        .versioningScheme("string")
        .build())
    .apiVersionSetId("string")
    .authenticationSettings(AuthenticationSettingsContractArgs.builder()
        .oAuth2(OAuth2AuthenticationSettingsContractArgs.builder()
            .authorizationServerId("string")
            .scope("string")
            .build())
        .oAuth2AuthenticationSettings(OAuth2AuthenticationSettingsContractArgs.builder()
            .authorizationServerId("string")
            .scope("string")
            .build())
        .openid(OpenIdAuthenticationSettingsContractArgs.builder()
            .bearerTokenSendingMethods("string")
            .openidProviderId("string")
            .build())
        .openidAuthenticationSettings(OpenIdAuthenticationSettingsContractArgs.builder()
            .bearerTokenSendingMethods("string")
            .openidProviderId("string")
            .build())
        .build())
    .contact(ApiContactInformationArgs.builder()
        .email("string")
        .name("string")
        .url("string")
        .build())
    .description("string")
    .displayName("string")
    .format("string")
    .isCurrent(false)
    .apiId("string")
    .apiVersion("string")
    .protocols("string")
    .apiVersionDescription("string")
    .apiRevisionDescription("string")
    .serviceUrl("string")
    .soapApiType("string")
    .sourceApiId("string")
    .subscriptionKeyParameterNames(SubscriptionKeyParameterNamesContractArgs.builder()
        .header("string")
        .query("string")
        .build())
    .subscriptionRequired(false)
    .termsOfServiceUrl("string")
    .translateRequiredQueryParametersConduct("string")
    .value("string")
    .apiRevision("string")
    .wsdlSelector(ApiCreateOrUpdatePropertiesWsdlSelectorArgs.builder()
        .wsdlEndpointName("string")
        .wsdlServiceName("string")
        .build())
    .build());
Copy
workspace_api_resource = azure_native.apimanagement.WorkspaceApi("workspaceApiResource",
    path="string",
    workspace_id="string",
    service_name="string",
    resource_group_name="string",
    license={
        "name": "string",
        "url": "string",
    },
    api_type="string",
    api_version_set={
        "description": "string",
        "id": "string",
        "name": "string",
        "version_header_name": "string",
        "version_query_name": "string",
        "versioning_scheme": "string",
    },
    api_version_set_id="string",
    authentication_settings={
        "o_auth2": {
            "authorization_server_id": "string",
            "scope": "string",
        },
        "o_auth2_authentication_settings": [{
            "authorization_server_id": "string",
            "scope": "string",
        }],
        "openid": {
            "bearer_token_sending_methods": ["string"],
            "openid_provider_id": "string",
        },
        "openid_authentication_settings": [{
            "bearer_token_sending_methods": ["string"],
            "openid_provider_id": "string",
        }],
    },
    contact={
        "email": "string",
        "name": "string",
        "url": "string",
    },
    description="string",
    display_name="string",
    format="string",
    is_current=False,
    api_id="string",
    api_version="string",
    protocols=["string"],
    api_version_description="string",
    api_revision_description="string",
    service_url="string",
    soap_api_type="string",
    source_api_id="string",
    subscription_key_parameter_names={
        "header": "string",
        "query": "string",
    },
    subscription_required=False,
    terms_of_service_url="string",
    translate_required_query_parameters_conduct="string",
    value="string",
    api_revision="string",
    wsdl_selector={
        "wsdl_endpoint_name": "string",
        "wsdl_service_name": "string",
    })
Copy
const workspaceApiResource = new azure_native.apimanagement.WorkspaceApi("workspaceApiResource", {
    path: "string",
    workspaceId: "string",
    serviceName: "string",
    resourceGroupName: "string",
    license: {
        name: "string",
        url: "string",
    },
    apiType: "string",
    apiVersionSet: {
        description: "string",
        id: "string",
        name: "string",
        versionHeaderName: "string",
        versionQueryName: "string",
        versioningScheme: "string",
    },
    apiVersionSetId: "string",
    authenticationSettings: {
        oAuth2: {
            authorizationServerId: "string",
            scope: "string",
        },
        oAuth2AuthenticationSettings: [{
            authorizationServerId: "string",
            scope: "string",
        }],
        openid: {
            bearerTokenSendingMethods: ["string"],
            openidProviderId: "string",
        },
        openidAuthenticationSettings: [{
            bearerTokenSendingMethods: ["string"],
            openidProviderId: "string",
        }],
    },
    contact: {
        email: "string",
        name: "string",
        url: "string",
    },
    description: "string",
    displayName: "string",
    format: "string",
    isCurrent: false,
    apiId: "string",
    apiVersion: "string",
    protocols: ["string"],
    apiVersionDescription: "string",
    apiRevisionDescription: "string",
    serviceUrl: "string",
    soapApiType: "string",
    sourceApiId: "string",
    subscriptionKeyParameterNames: {
        header: "string",
        query: "string",
    },
    subscriptionRequired: false,
    termsOfServiceUrl: "string",
    translateRequiredQueryParametersConduct: "string",
    value: "string",
    apiRevision: "string",
    wsdlSelector: {
        wsdlEndpointName: "string",
        wsdlServiceName: "string",
    },
});
Copy
type: azure-native:apimanagement:WorkspaceApi
properties:
    apiId: string
    apiRevision: string
    apiRevisionDescription: string
    apiType: string
    apiVersion: string
    apiVersionDescription: string
    apiVersionSet:
        description: string
        id: string
        name: string
        versionHeaderName: string
        versionQueryName: string
        versioningScheme: string
    apiVersionSetId: string
    authenticationSettings:
        oAuth2:
            authorizationServerId: string
            scope: string
        oAuth2AuthenticationSettings:
            - authorizationServerId: string
              scope: string
        openid:
            bearerTokenSendingMethods:
                - string
            openidProviderId: string
        openidAuthenticationSettings:
            - bearerTokenSendingMethods:
                - string
              openidProviderId: string
    contact:
        email: string
        name: string
        url: string
    description: string
    displayName: string
    format: string
    isCurrent: false
    license:
        name: string
        url: string
    path: string
    protocols:
        - string
    resourceGroupName: string
    serviceName: string
    serviceUrl: string
    soapApiType: string
    sourceApiId: string
    subscriptionKeyParameterNames:
        header: string
        query: string
    subscriptionRequired: false
    termsOfServiceUrl: string
    translateRequiredQueryParametersConduct: string
    value: string
    workspaceId: string
    wsdlSelector:
        wsdlEndpointName: string
        wsdlServiceName: string
Copy

WorkspaceApi Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The WorkspaceApi resource accepts the following input properties:

Path This property is required. 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
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
ApiId Changes to this property will trigger replacement. 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.ApiVersionSetContractDetails
Version set details
ApiVersionSetId string
A resource identifier for the related ApiVersionSet.
AuthenticationSettings Pulumi.AzureNative.ApiManagement.Inputs.AuthenticationSettingsContract
Collection of authentication settings included into this API.
Contact Pulumi.AzureNative.ApiManagement.Inputs.ApiContactInformation
Contact information for the 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.
License Pulumi.AzureNative.ApiManagement.Inputs.ApiLicenseInformation
License information for the API.
Protocols List<Union<string, 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 REST API
  • soap creates a SOAP pass-through API
  • websocket creates websocket API
  • graphql creates GraphQL API.
SourceApiId string
API identifier of the source API.
SubscriptionKeyParameterNames Pulumi.AzureNative.ApiManagement.Inputs.SubscriptionKeyParameterNamesContract
Protocols over which API is made available.
SubscriptionRequired bool
Specifies whether an API or Product subscription is required for accessing the API.
TermsOfServiceUrl string
A URL to the Terms of Service for the API. MUST be in the format of a URL.
TranslateRequiredQueryParametersConduct string | Pulumi.AzureNative.ApiManagement.TranslateRequiredQueryParametersConduct
Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'
Value string
Content value when Importing an API.
WsdlSelector Pulumi.AzureNative.ApiManagement.Inputs.ApiCreateOrUpdatePropertiesWsdlSelector
Criteria to limit import of WSDL to a subset of the document.
Path This property is required. 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
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
ApiId Changes to this property will trigger replacement. 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.
Contact ApiContactInformationArgs
Contact information for the 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.
License ApiLicenseInformationArgs
License information for the API.
Protocols []string
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 REST API
  • soap creates a SOAP pass-through API
  • websocket creates websocket API
  • graphql creates GraphQL 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.
TermsOfServiceUrl string
A URL to the Terms of Service for the API. MUST be in the format of a URL.
TranslateRequiredQueryParametersConduct string | TranslateRequiredQueryParametersConduct
Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'
Value string
Content value when Importing an API.
WsdlSelector ApiCreateOrUpdatePropertiesWsdlSelectorArgs
Criteria to limit import of WSDL to a subset of the document.
path This property is required. 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
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.
apiId Changes to this property will trigger replacement. 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 ApiVersionSetContractDetails
Version set details
apiVersionSetId String
A resource identifier for the related ApiVersionSet.
authenticationSettings AuthenticationSettingsContract
Collection of authentication settings included into this API.
contact ApiContactInformation
Contact information for the 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.
license ApiLicenseInformation
License information for the API.
protocols List<Either<String,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 REST API
  • soap creates a SOAP pass-through API
  • websocket creates websocket API
  • graphql creates GraphQL API.
sourceApiId String
API identifier of the source API.
subscriptionKeyParameterNames SubscriptionKeyParameterNamesContract
Protocols over which API is made available.
subscriptionRequired Boolean
Specifies whether an API or Product subscription is required for accessing the API.
termsOfServiceUrl String
A URL to the Terms of Service for the API. MUST be in the format of a URL.
translateRequiredQueryParametersConduct String | TranslateRequiredQueryParametersConduct
Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'
value String
Content value when Importing an API.
wsdlSelector ApiCreateOrUpdatePropertiesWsdlSelector
Criteria to limit import of WSDL to a subset of the document.
path This property is required. 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
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
apiId Changes to this property will trigger replacement. 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 ApiVersionSetContractDetails
Version set details
apiVersionSetId string
A resource identifier for the related ApiVersionSet.
authenticationSettings AuthenticationSettingsContract
Collection of authentication settings included into this API.
contact ApiContactInformation
Contact information for the 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.
license ApiLicenseInformation
License information for the API.
protocols (string | 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 REST API
  • soap creates a SOAP pass-through API
  • websocket creates websocket API
  • graphql creates GraphQL API.
sourceApiId string
API identifier of the source API.
subscriptionKeyParameterNames SubscriptionKeyParameterNamesContract
Protocols over which API is made available.
subscriptionRequired boolean
Specifies whether an API or Product subscription is required for accessing the API.
termsOfServiceUrl string
A URL to the Terms of Service for the API. MUST be in the format of a URL.
translateRequiredQueryParametersConduct string | TranslateRequiredQueryParametersConduct
Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'
value string
Content value when Importing an API.
wsdlSelector ApiCreateOrUpdatePropertiesWsdlSelector
Criteria to limit import of WSDL to a subset of the document.
path This property is required. 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
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
workspace_id
This property is required.
Changes to this property will trigger replacement.
str
Workspace identifier. Must be unique in the current API Management service instance.
api_id Changes to this property will trigger replacement. 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.
contact ApiContactInformationArgs
Contact information for the API.
description str
Description of the API. May include HTML formatting tags.
display_name str
API name. Must be 1 to 300 characters long.
format str | ContentFormat
Format of the Content in which the API is getting imported.
is_current bool
Indicates if API revision is current api revision.
license ApiLicenseInformationArgs
License information for the API.
protocols Sequence[Union[str, Protocol]]
Describes on which protocols the operations in this API can be invoked.
service_url str
Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
soap_api_type str | SoapApiType
Type of API to create.

  • http creates a REST API
  • soap creates a SOAP pass-through API
  • websocket creates websocket API
  • graphql creates GraphQL 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.
terms_of_service_url str
A URL to the Terms of Service for the API. MUST be in the format of a URL.
translate_required_query_parameters_conduct str | TranslateRequiredQueryParametersConduct
Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'
value str
Content value when Importing an API.
wsdl_selector ApiCreateOrUpdatePropertiesWsdlSelectorArgs
Criteria to limit import of WSDL to a subset of the document.
path This property is required. 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
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.
apiId Changes to this property will trigger replacement. 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" | "websocket" | "graphql"
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.
contact Property Map
Contact information for the 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" | "graphql-link"
Format of the Content in which the API is getting imported.
isCurrent Boolean
Indicates if API revision is current api revision.
license Property Map
License information for the API.
protocols List<String | "http" | "https" | "ws" | "wss">
Describes on which protocols the operations in this API can be invoked.
serviceUrl String
Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
soapApiType String | "http" | "soap" | "websocket" | "graphql"
Type of API to create.

  • http creates a REST API
  • soap creates a SOAP pass-through API
  • websocket creates websocket API
  • graphql creates GraphQL 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.
termsOfServiceUrl String
A URL to the Terms of Service for the API. MUST be in the format of a URL.
translateRequiredQueryParametersConduct String | "template" | "query"
Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'
value String
Content value when Importing an API.
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 WorkspaceApi resource produces the following output properties:

AzureApiVersion string
The Azure API version of the 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
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the 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
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the 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
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the 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
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the 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
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the 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
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

ApiContactInformation
, ApiContactInformationArgs

Email string
The email address of the contact person/organization. MUST be in the format of an email address
Name string
The identifying name of the contact person/organization
Url string
The URL pointing to the contact information. MUST be in the format of a URL
Email string
The email address of the contact person/organization. MUST be in the format of an email address
Name string
The identifying name of the contact person/organization
Url string
The URL pointing to the contact information. MUST be in the format of a URL
email String
The email address of the contact person/organization. MUST be in the format of an email address
name String
The identifying name of the contact person/organization
url String
The URL pointing to the contact information. MUST be in the format of a URL
email string
The email address of the contact person/organization. MUST be in the format of an email address
name string
The identifying name of the contact person/organization
url string
The URL pointing to the contact information. MUST be in the format of a URL
email str
The email address of the contact person/organization. MUST be in the format of an email address
name str
The identifying name of the contact person/organization
url str
The URL pointing to the contact information. MUST be in the format of a URL
email String
The email address of the contact person/organization. MUST be in the format of an email address
name String
The identifying name of the contact person/organization
url String
The URL pointing to the contact information. MUST be in the format of a URL

ApiContactInformationResponse
, ApiContactInformationResponseArgs

Email string
The email address of the contact person/organization. MUST be in the format of an email address
Name string
The identifying name of the contact person/organization
Url string
The URL pointing to the contact information. MUST be in the format of a URL
Email string
The email address of the contact person/organization. MUST be in the format of an email address
Name string
The identifying name of the contact person/organization
Url string
The URL pointing to the contact information. MUST be in the format of a URL
email String
The email address of the contact person/organization. MUST be in the format of an email address
name String
The identifying name of the contact person/organization
url String
The URL pointing to the contact information. MUST be in the format of a URL
email string
The email address of the contact person/organization. MUST be in the format of an email address
name string
The identifying name of the contact person/organization
url string
The URL pointing to the contact information. MUST be in the format of a URL
email str
The email address of the contact person/organization. MUST be in the format of an email address
name str
The identifying name of the contact person/organization
url str
The URL pointing to the contact information. MUST be in the format of a URL
email String
The email address of the contact person/organization. MUST be in the format of an email address
name String
The identifying name of the contact person/organization
url String
The URL pointing to the contact information. MUST be in the format of a URL

ApiCreateOrUpdatePropertiesWsdlSelector
, ApiCreateOrUpdatePropertiesWsdlSelectorArgs

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

ApiLicenseInformation
, ApiLicenseInformationArgs

Name string
The license name used for the API
Url string
A URL to the license used for the API. MUST be in the format of a URL
Name string
The license name used for the API
Url string
A URL to the license used for the API. MUST be in the format of a URL
name String
The license name used for the API
url String
A URL to the license used for the API. MUST be in the format of a URL
name string
The license name used for the API
url string
A URL to the license used for the API. MUST be in the format of a URL
name str
The license name used for the API
url str
A URL to the license used for the API. MUST be in the format of a URL
name String
The license name used for the API
url String
A URL to the license used for the API. MUST be in the format of a URL

ApiLicenseInformationResponse
, ApiLicenseInformationResponseArgs

Name string
The license name used for the API
Url string
A URL to the license used for the API. MUST be in the format of a URL
Name string
The license name used for the API
Url string
A URL to the license used for the API. MUST be in the format of a URL
name String
The license name used for the API
url String
A URL to the license used for the API. MUST be in the format of a URL
name string
The license name used for the API
url string
A URL to the license used for the API. MUST be in the format of a URL
name str
The license name used for the API
url str
A URL to the license used for the API. MUST be in the format of a URL
name String
The license name used for the API
url String
A URL to the license used for the API. MUST be in the format of a URL

ApiType
, ApiTypeArgs

Http
http
Soap
soap
Websocket
websocket
Graphql
graphql
ApiTypeHttp
http
ApiTypeSoap
soap
ApiTypeWebsocket
websocket
ApiTypeGraphql
graphql
Http
http
Soap
soap
Websocket
websocket
Graphql
graphql
Http
http
Soap
soap
Websocket
websocket
Graphql
graphql
HTTP
http
SOAP
soap
WEBSOCKET
websocket
GRAPHQL
graphql
"http"
http
"soap"
soap
"websocket"
websocket
"graphql"
graphql

ApiVersionSetContractDetails
, ApiVersionSetContractDetailsArgs

Description string
Description of API Version Set.
Id string
Identifier for existing API Version Set. Omit this value to create a new Version Set.
Name string
The display Name of the API Version Set.
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 | Pulumi.AzureNative.ApiManagement.VersioningScheme
An value that determines where the API Version identifier will be located in a HTTP request.
Description string
Description of API Version Set.
Id string
Identifier for existing API Version Set. Omit this value to create a new Version Set.
Name string
The display Name of the API Version Set.
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 | VersioningScheme
An value that determines where the API Version identifier will be located in a HTTP request.
description String
Description of API Version Set.
id String
Identifier for existing API Version Set. Omit this value to create a new Version Set.
name String
The display Name of the API Version Set.
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 | VersioningScheme
An value that determines where the API Version identifier will be located in a HTTP request.
description string
Description of API Version Set.
id string
Identifier for existing API Version Set. Omit this value to create a new Version Set.
name string
The display Name of the API Version Set.
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 | VersioningScheme
An value that determines where the API Version identifier will be located in a HTTP request.
description str
Description of API Version Set.
id str
Identifier for existing API Version Set. Omit this value to create a new Version Set.
name str
The display Name of the API Version Set.
version_header_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 | VersioningScheme
An value that determines where the API Version identifier will be located in a HTTP request.
description String
Description of API Version Set.
id String
Identifier for existing API Version Set. Omit this value to create a new Version Set.
name String
The display Name of the API Version Set.
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 | "Segment" | "Query" | "Header"
An value that determines where the API Version identifier will be located in a HTTP request.

ApiVersionSetContractDetailsResponse
, ApiVersionSetContractDetailsResponseArgs

Description string
Description of API Version Set.
Id string
Identifier for existing API Version Set. Omit this value to create a new Version Set.
Name string
The display Name of the API Version Set.
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
, AuthenticationSettingsContractArgs

OAuth2 OAuth2AuthenticationSettingsContract
OAuth2 Authentication settings
OAuth2AuthenticationSettings []OAuth2AuthenticationSettingsContract
Collection of OAuth2 authentication settings included into this API.
Openid OpenIdAuthenticationSettingsContract
OpenID Connect Authentication Settings
OpenidAuthenticationSettings []OpenIdAuthenticationSettingsContract
Collection of Open ID Connect authentication settings included into this API.
oAuth2 OAuth2AuthenticationSettingsContract
OAuth2 Authentication settings
oAuth2AuthenticationSettings List<OAuth2AuthenticationSettingsContract>
Collection of OAuth2 authentication settings included into this API.
openid OpenIdAuthenticationSettingsContract
OpenID Connect Authentication Settings
openidAuthenticationSettings List<OpenIdAuthenticationSettingsContract>
Collection of Open ID Connect authentication settings included into this API.
oAuth2 OAuth2AuthenticationSettingsContract
OAuth2 Authentication settings
oAuth2AuthenticationSettings OAuth2AuthenticationSettingsContract[]
Collection of OAuth2 authentication settings included into this API.
openid OpenIdAuthenticationSettingsContract
OpenID Connect Authentication Settings
openidAuthenticationSettings OpenIdAuthenticationSettingsContract[]
Collection of Open ID Connect authentication settings included into this API.
o_auth2 OAuth2AuthenticationSettingsContract
OAuth2 Authentication settings
o_auth2_authentication_settings Sequence[OAuth2AuthenticationSettingsContract]
Collection of OAuth2 authentication settings included into this API.
openid OpenIdAuthenticationSettingsContract
OpenID Connect Authentication Settings
openid_authentication_settings Sequence[OpenIdAuthenticationSettingsContract]
Collection of Open ID Connect authentication settings included into this API.
oAuth2 Property Map
OAuth2 Authentication settings
oAuth2AuthenticationSettings List<Property Map>
Collection of OAuth2 authentication settings included into this API.
openid Property Map
OpenID Connect Authentication Settings
openidAuthenticationSettings List<Property Map>
Collection of Open ID Connect authentication settings included into this API.

AuthenticationSettingsContractResponse
, AuthenticationSettingsContractResponseArgs

OAuth2 OAuth2AuthenticationSettingsContractResponse
OAuth2 Authentication settings
OAuth2AuthenticationSettings []OAuth2AuthenticationSettingsContractResponse
Collection of OAuth2 authentication settings included into this API.
Openid OpenIdAuthenticationSettingsContractResponse
OpenID Connect Authentication Settings
OpenidAuthenticationSettings []OpenIdAuthenticationSettingsContractResponse
Collection of Open ID Connect authentication settings included into this API.
oAuth2 OAuth2AuthenticationSettingsContractResponse
OAuth2 Authentication settings
oAuth2AuthenticationSettings List<OAuth2AuthenticationSettingsContractResponse>
Collection of OAuth2 authentication settings included into this API.
openid OpenIdAuthenticationSettingsContractResponse
OpenID Connect Authentication Settings
openidAuthenticationSettings List<OpenIdAuthenticationSettingsContractResponse>
Collection of Open ID Connect authentication settings included into this API.
oAuth2 OAuth2AuthenticationSettingsContractResponse
OAuth2 Authentication settings
oAuth2AuthenticationSettings OAuth2AuthenticationSettingsContractResponse[]
Collection of OAuth2 authentication settings included into this API.
openid OpenIdAuthenticationSettingsContractResponse
OpenID Connect Authentication Settings
openidAuthenticationSettings OpenIdAuthenticationSettingsContractResponse[]
Collection of Open ID Connect authentication settings included into this API.
o_auth2 OAuth2AuthenticationSettingsContractResponse
OAuth2 Authentication settings
o_auth2_authentication_settings Sequence[OAuth2AuthenticationSettingsContractResponse]
Collection of OAuth2 authentication settings included into this API.
openid OpenIdAuthenticationSettingsContractResponse
OpenID Connect Authentication Settings
openid_authentication_settings Sequence[OpenIdAuthenticationSettingsContractResponse]
Collection of Open ID Connect authentication settings included into this API.
oAuth2 Property Map
OAuth2 Authentication settings
oAuth2AuthenticationSettings List<Property Map>
Collection of OAuth2 authentication settings included into this API.
openid Property Map
OpenID Connect Authentication Settings
openidAuthenticationSettings List<Property Map>
Collection of Open ID Connect authentication settings included into this API.

BearerTokenSendingMethods
, BearerTokenSendingMethodsArgs

AuthorizationHeader
authorizationHeaderAccess token will be transmitted in the Authorization header using Bearer schema
Query
queryAccess token will be transmitted as query parameters.
BearerTokenSendingMethodsAuthorizationHeader
authorizationHeaderAccess token will be transmitted in the Authorization header using Bearer schema
BearerTokenSendingMethodsQuery
queryAccess token will be transmitted as query parameters.
AuthorizationHeader
authorizationHeaderAccess token will be transmitted in the Authorization header using Bearer schema
Query
queryAccess token will be transmitted as query parameters.
AuthorizationHeader
authorizationHeaderAccess token will be transmitted in the Authorization header using Bearer schema
Query
queryAccess token will be transmitted as query parameters.
AUTHORIZATION_HEADER
authorizationHeaderAccess token will be transmitted in the Authorization header using Bearer schema
QUERY
queryAccess token will be transmitted as query parameters.
"authorizationHeader"
authorizationHeaderAccess token will be transmitted in the Authorization header using Bearer schema
"query"
queryAccess token will be transmitted as query parameters.

ContentFormat
, ContentFormatArgs

Wadl_xml
wadl-xmlThe contents are inline and Content type is a WADL document.
Wadl_link_json
wadl-link-jsonThe WADL document is hosted on a publicly accessible internet address.
Swagger_json
swagger-jsonThe contents are inline and Content Type is a OpenAPI 2.0 JSON Document.
Swagger_link_json
swagger-link-jsonThe OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.
Wsdl
wsdlThe contents are inline and the document is a WSDL/Soap document.
Wsdl_link
wsdl-linkThe WSDL document is hosted on a publicly accessible internet address.
Openapi
openapiThe contents are inline and Content Type is a OpenAPI 3.0 YAML Document.
Openapi_json
openapi+jsonThe contents are inline and Content Type is a OpenAPI 3.0 JSON Document.
Openapi_link
openapi-linkThe OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.
Openapi_json_link
openapi+json-linkThe OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.
Graphql_link
graphql-linkThe GraphQL API endpoint hosted on a publicly accessible internet address.
ContentFormat_Wadl_Xml
wadl-xmlThe contents are inline and Content type is a WADL document.
ContentFormat_Wadl_Link_Json
wadl-link-jsonThe WADL document is hosted on a publicly accessible internet address.
ContentFormat_Swagger_Json
swagger-jsonThe contents are inline and Content Type is a OpenAPI 2.0 JSON Document.
ContentFormat_Swagger_Link_Json
swagger-link-jsonThe OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.
ContentFormatWsdl
wsdlThe contents are inline and the document is a WSDL/Soap document.
ContentFormat_Wsdl_Link
wsdl-linkThe WSDL document is hosted on a publicly accessible internet address.
ContentFormatOpenapi
openapiThe contents are inline and Content Type is a OpenAPI 3.0 YAML Document.
ContentFormat_Openapi_json
openapi+jsonThe contents are inline and Content Type is a OpenAPI 3.0 JSON Document.
ContentFormat_Openapi_Link
openapi-linkThe OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.
ContentFormat_Openapi_json_Link
openapi+json-linkThe OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.
ContentFormat_Graphql_Link
graphql-linkThe GraphQL API endpoint hosted on a publicly accessible internet address.
Wadlxml
wadl-xmlThe contents are inline and Content type is a WADL document.
Wadllinkjson
wadl-link-jsonThe WADL document is hosted on a publicly accessible internet address.
Swaggerjson
swagger-jsonThe contents are inline and Content Type is a OpenAPI 2.0 JSON Document.
Swaggerlinkjson
swagger-link-jsonThe OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.
Wsdl
wsdlThe contents are inline and the document is a WSDL/Soap document.
Wsdllink
wsdl-linkThe WSDL document is hosted on a publicly accessible internet address.
Openapi
openapiThe contents are inline and Content Type is a OpenAPI 3.0 YAML Document.
Openapi_json
openapi+jsonThe contents are inline and Content Type is a OpenAPI 3.0 JSON Document.
Openapilink
openapi-linkThe OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.
Openapi_jsonlink
openapi+json-linkThe OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.
Graphqllink
graphql-linkThe GraphQL API endpoint hosted on a publicly accessible internet address.
Wadl_xml
wadl-xmlThe contents are inline and Content type is a WADL document.
Wadl_link_json
wadl-link-jsonThe WADL document is hosted on a publicly accessible internet address.
Swagger_json
swagger-jsonThe contents are inline and Content Type is a OpenAPI 2.0 JSON Document.
Swagger_link_json
swagger-link-jsonThe OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.
Wsdl
wsdlThe contents are inline and the document is a WSDL/Soap document.
Wsdl_link
wsdl-linkThe WSDL document is hosted on a publicly accessible internet address.
Openapi
openapiThe contents are inline and Content Type is a OpenAPI 3.0 YAML Document.
Openapi_json
openapi+jsonThe contents are inline and Content Type is a OpenAPI 3.0 JSON Document.
Openapi_link
openapi-linkThe OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.
Openapi_json_link
openapi+json-linkThe OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.
Graphql_link
graphql-linkThe GraphQL API endpoint hosted on a publicly accessible internet address.
WADL_XML
wadl-xmlThe contents are inline and Content type is a WADL document.
WADL_LINK_JSON
wadl-link-jsonThe WADL document is hosted on a publicly accessible internet address.
SWAGGER_JSON
swagger-jsonThe contents are inline and Content Type is a OpenAPI 2.0 JSON Document.
SWAGGER_LINK_JSON
swagger-link-jsonThe OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.
WSDL
wsdlThe contents are inline and the document is a WSDL/Soap document.
WSDL_LINK
wsdl-linkThe WSDL document is hosted on a publicly accessible internet address.
OPENAPI
openapiThe contents are inline and Content Type is a OpenAPI 3.0 YAML Document.
OPENAPI_JSON
openapi+jsonThe contents are inline and Content Type is a OpenAPI 3.0 JSON Document.
OPENAPI_LINK
openapi-linkThe OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.
OPENAPI_JSON_LINK
openapi+json-linkThe OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.
GRAPHQL_LINK
graphql-linkThe GraphQL API endpoint hosted on a publicly accessible internet address.
"wadl-xml"
wadl-xmlThe contents are inline and Content type is a WADL document.
"wadl-link-json"
wadl-link-jsonThe WADL document is hosted on a publicly accessible internet address.
"swagger-json"
swagger-jsonThe contents are inline and Content Type is a OpenAPI 2.0 JSON Document.
"swagger-link-json"
swagger-link-jsonThe OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.
"wsdl"
wsdlThe contents are inline and the document is a WSDL/Soap document.
"wsdl-link"
wsdl-linkThe WSDL document is hosted on a publicly accessible internet address.
"openapi"
openapiThe contents are inline and Content Type is a OpenAPI 3.0 YAML Document.
"openapi+json"
openapi+jsonThe contents are inline and Content Type is a OpenAPI 3.0 JSON Document.
"openapi-link"
openapi-linkThe OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.
"openapi+json-link"
openapi+json-linkThe OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.
"graphql-link"
graphql-linkThe GraphQL API endpoint hosted on a publicly accessible internet address.

OAuth2AuthenticationSettingsContract
, OAuth2AuthenticationSettingsContractArgs

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
, OAuth2AuthenticationSettingsContractResponseArgs

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
, OpenIdAuthenticationSettingsContractArgs

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 List<Either<String,BearerTokenSendingMethods>>
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 List<String | "authorizationHeader" | "query">
How to send token to the server.
openidProviderId String
OAuth authorization server identifier.

OpenIdAuthenticationSettingsContractResponse
, OpenIdAuthenticationSettingsContractResponseArgs

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<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.
bearer_token_sending_methods Sequence[str]
How to send token to the server.
openid_provider_id str
OAuth authorization server identifier.
bearerTokenSendingMethods List<String>
How to send token to the server.
openidProviderId String
OAuth authorization server identifier.

Protocol
, ProtocolArgs

Http
http
Https
https
Ws
ws
Wss
wss
ProtocolHttp
http
ProtocolHttps
https
ProtocolWs
ws
ProtocolWss
wss
Http
http
Https
https
Ws
ws
Wss
wss
Http
http
Https
https
Ws
ws
Wss
wss
HTTP
http
HTTPS
https
WS
ws
WSS
wss
"http"
http
"https"
https
"ws"
ws
"wss"
wss

SoapApiType
, SoapApiTypeArgs

SoapToRest
httpImports a SOAP API having a RESTful front end.
SoapPassThrough
soapImports the SOAP API having a SOAP front end.
WebSocket
websocketImports the API having a Websocket front end.
GraphQL
graphqlImports the API having a GraphQL front end.
SoapApiTypeSoapToRest
httpImports a SOAP API having a RESTful front end.
SoapApiTypeSoapPassThrough
soapImports the SOAP API having a SOAP front end.
SoapApiTypeWebSocket
websocketImports the API having a Websocket front end.
SoapApiTypeGraphQL
graphqlImports the API having a GraphQL front end.
SoapToRest
httpImports a SOAP API having a RESTful front end.
SoapPassThrough
soapImports the SOAP API having a SOAP front end.
WebSocket
websocketImports the API having a Websocket front end.
GraphQL
graphqlImports the API having a GraphQL front end.
SoapToRest
httpImports a SOAP API having a RESTful front end.
SoapPassThrough
soapImports the SOAP API having a SOAP front end.
WebSocket
websocketImports the API having a Websocket front end.
GraphQL
graphqlImports the API having a GraphQL front end.
SOAP_TO_REST
httpImports a SOAP API having a RESTful front end.
SOAP_PASS_THROUGH
soapImports the SOAP API having a SOAP front end.
WEB_SOCKET
websocketImports the API having a Websocket front end.
GRAPH_QL
graphqlImports the API having a GraphQL front end.
"http"
httpImports a SOAP API having a RESTful front end.
"soap"
soapImports the SOAP API having a SOAP front end.
"websocket"
websocketImports the API having a Websocket front end.
"graphql"
graphqlImports the API having a GraphQL front end.

SubscriptionKeyParameterNamesContract
, SubscriptionKeyParameterNamesContractArgs

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
, SubscriptionKeyParameterNamesContractResponseArgs

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.

TranslateRequiredQueryParametersConduct
, TranslateRequiredQueryParametersConductArgs

Template
templateTranslates required query parameters to template ones. Is a default value
Query
queryLeaves required query parameters as they are (no translation done).
TranslateRequiredQueryParametersConductTemplate
templateTranslates required query parameters to template ones. Is a default value
TranslateRequiredQueryParametersConductQuery
queryLeaves required query parameters as they are (no translation done).
Template
templateTranslates required query parameters to template ones. Is a default value
Query
queryLeaves required query parameters as they are (no translation done).
Template
templateTranslates required query parameters to template ones. Is a default value
Query
queryLeaves required query parameters as they are (no translation done).
TEMPLATE
templateTranslates required query parameters to template ones. Is a default value
QUERY
queryLeaves required query parameters as they are (no translation done).
"template"
templateTranslates required query parameters to template ones. Is a default value
"query"
queryLeaves required query parameters as they are (no translation done).

VersioningScheme
, VersioningSchemeArgs

Segment
SegmentThe API Version is passed in a path segment.
Query
QueryThe API Version is passed in a query parameter.
Header
HeaderThe API Version is passed in a HTTP header.
VersioningSchemeSegment
SegmentThe API Version is passed in a path segment.
VersioningSchemeQuery
QueryThe API Version is passed in a query parameter.
VersioningSchemeHeader
HeaderThe API Version is passed in a HTTP header.
Segment
SegmentThe API Version is passed in a path segment.
Query
QueryThe API Version is passed in a query parameter.
Header
HeaderThe API Version is passed in a HTTP header.
Segment
SegmentThe API Version is passed in a path segment.
Query
QueryThe API Version is passed in a query parameter.
Header
HeaderThe API Version is passed in a HTTP header.
SEGMENT
SegmentThe API Version is passed in a path segment.
QUERY
QueryThe API Version is passed in a query parameter.
HEADER
HeaderThe API Version is passed in a HTTP header.
"Segment"
SegmentThe API Version is passed in a path segment.
"Query"
QueryThe API Version is passed in a query parameter.
"Header"
HeaderThe API Version is passed in a HTTP header.

Import

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

$ pulumi import azure-native:apimanagement:WorkspaceApi apiid9419 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native