azure.apimanagement.Api
Manages an API within an API Management Service.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var exampleService = new Azure.ApiManagement.Service("exampleService", new()
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
PublisherName = "My Company",
PublisherEmail = "company@exmaple.com",
SkuName = "Developer_1",
});
var exampleApi = new Azure.ApiManagement.Api("exampleApi", new()
{
ResourceGroupName = exampleResourceGroup.Name,
ApiManagementName = exampleService.Name,
Revision = "1",
DisplayName = "Example API",
Path = "example",
Protocols = new[]
{
"https",
},
Import = new Azure.ApiManagement.Inputs.ApiImportArgs
{
ContentFormat = "swagger-link-json",
ContentValue = "http://conferenceapi.azurewebsites.net/?format=json",
},
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleService, err := apimanagement.NewService(ctx, "exampleService", &apimanagement.ServiceArgs{
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
PublisherName: pulumi.String("My Company"),
PublisherEmail: pulumi.String("company@exmaple.com"),
SkuName: pulumi.String("Developer_1"),
})
if err != nil {
return err
}
_, err = apimanagement.NewApi(ctx, "exampleApi", &apimanagement.ApiArgs{
ResourceGroupName: exampleResourceGroup.Name,
ApiManagementName: exampleService.Name,
Revision: pulumi.String("1"),
DisplayName: pulumi.String("Example API"),
Path: pulumi.String("example"),
Protocols: pulumi.StringArray{
pulumi.String("https"),
},
Import: &apimanagement.ApiImportArgs{
ContentFormat: pulumi.String("swagger-link-json"),
ContentValue: pulumi.String("http://conferenceapi.azurewebsites.net/?format=json"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.apimanagement.Service;
import com.pulumi.azure.apimanagement.ServiceArgs;
import com.pulumi.azure.apimanagement.Api;
import com.pulumi.azure.apimanagement.ApiArgs;
import com.pulumi.azure.apimanagement.inputs.ApiImportArgs;
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleService = new Service("exampleService", ServiceArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.publisherName("My Company")
.publisherEmail("company@exmaple.com")
.skuName("Developer_1")
.build());
var exampleApi = new Api("exampleApi", ApiArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.apiManagementName(exampleService.name())
.revision("1")
.displayName("Example API")
.path("example")
.protocols("https")
.import_(ApiImportArgs.builder()
.contentFormat("swagger-link-json")
.contentValue("http://conferenceapi.azurewebsites.net/?format=json")
.build())
.build());
}
}
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
location=example_resource_group.location,
resource_group_name=example_resource_group.name,
publisher_name="My Company",
publisher_email="company@exmaple.com",
sku_name="Developer_1")
example_api = azure.apimanagement.Api("exampleApi",
resource_group_name=example_resource_group.name,
api_management_name=example_service.name,
revision="1",
display_name="Example API",
path="example",
protocols=["https"],
import_=azure.apimanagement.ApiImportArgs(
content_format="swagger-link-json",
content_value="http://conferenceapi.azurewebsites.net/?format=json",
))
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
publisherName: "My Company",
publisherEmail: "company@exmaple.com",
skuName: "Developer_1",
});
const exampleApi = new azure.apimanagement.Api("exampleApi", {
resourceGroupName: exampleResourceGroup.name,
apiManagementName: exampleService.name,
revision: "1",
displayName: "Example API",
path: "example",
protocols: ["https"],
"import": {
contentFormat: "swagger-link-json",
contentValue: "http://conferenceapi.azurewebsites.net/?format=json",
},
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
exampleService:
type: azure:apimanagement:Service
properties:
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
publisherName: My Company
publisherEmail: company@exmaple.com
skuName: Developer_1
exampleApi:
type: azure:apimanagement:Api
properties:
resourceGroupName: ${exampleResourceGroup.name}
apiManagementName: ${exampleService.name}
revision: '1'
displayName: Example API
path: example
protocols:
- https
import:
contentFormat: swagger-link-json
contentValue: http://conferenceapi.azurewebsites.net/?format=json
Create Api Resource
new Api(name: string, args: ApiArgs, opts?: CustomResourceOptions);
@overload
def Api(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_management_name: Optional[str] = None,
api_type: Optional[str] = None,
contact: Optional[ApiContactArgs] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
import_: Optional[ApiImportArgs] = None,
license: Optional[ApiLicenseArgs] = None,
name: Optional[str] = None,
oauth2_authorization: Optional[ApiOauth2AuthorizationArgs] = None,
openid_authentication: Optional[ApiOpenidAuthenticationArgs] = None,
path: Optional[str] = None,
protocols: Optional[Sequence[str]] = None,
resource_group_name: Optional[str] = None,
revision: Optional[str] = None,
revision_description: Optional[str] = None,
service_url: Optional[str] = None,
soap_pass_through: Optional[bool] = None,
source_api_id: Optional[str] = None,
subscription_key_parameter_names: Optional[ApiSubscriptionKeyParameterNamesArgs] = None,
subscription_required: Optional[bool] = None,
terms_of_service_url: Optional[str] = None,
version: Optional[str] = None,
version_description: Optional[str] = None,
version_set_id: Optional[str] = None)
@overload
def Api(resource_name: str,
args: ApiArgs,
opts: Optional[ResourceOptions] = None)
func NewApi(ctx *Context, name string, args ApiArgs, opts ...ResourceOption) (*Api, error)
public Api(string name, ApiArgs args, CustomResourceOptions? opts = null)
type: azure:apimanagement:Api
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Api Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Api resource accepts the following input properties:
- Api
Management stringName The Name of the API Management Service where this API should be created. Changing this forces a new resource to be created.
- Resource
Group stringName The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created.
- Revision string
The Revision which used for this API. Changing this forces a new resource to be created.
- Api
Type string Type of API. Possible values are
graphql
,http
,soap
, andwebsocket
. Defaults tohttp
.- Contact
Api
Contact Args A
contact
block as documented below.- Description string
A description of the API Management API, which may include HTML formatting tags.
- Display
Name string The display name of the API.
- Import
Api
Import Args A
import
block as documented below.- License
Api
License Args A
license
block as documented below.- Name string
The name of the API Management API. Changing this forces a new resource to be created.
- Api
Oauth2Authorization Args An
oauth2_authorization
block as documented below.- Openid
Authentication ApiOpenid Authentication Args An
openid_authentication
block as documented below.- Path string
The Path for this API Management API, which is a relative URL which uniquely identifies this API and all of its resource paths within the API Management Service.
- Protocols List<string>
A list of protocols the operations in this API can be invoked. Possible values are
http
,https
,ws
, andwss
.- Revision
Description string The description of the API Revision of the API Management API.
- Service
Url string Absolute URL of the backend service implementing this API.
- Soap
Pass boolThrough Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to
false
.soap_pass_through
will be removed in favour of the propertyapi_type
in version 4.0 of the AzureRM Provider- Source
Api stringId The API id of the source API, which could be in format
azurerm_api_management_api.example.id
or in formatazurerm_api_management_api.example.id;rev=1
- Subscription
Key ApiParameter Names Subscription Key Parameter Names Args A
subscription_key_parameter_names
block as documented below.- Subscription
Required bool Should this API require a subscription key? Defaults to
true
.- Terms
Of stringService Url Absolute URL of the Terms of Service for the API.
- Version string
The Version number of this API, if this API is versioned.
- Version
Description string The description of the API Version of the API Management API.
- Version
Set stringId The ID of the Version Set which this API is associated with.
- Api
Management stringName The Name of the API Management Service where this API should be created. Changing this forces a new resource to be created.
- Resource
Group stringName The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created.
- Revision string
The Revision which used for this API. Changing this forces a new resource to be created.
- Api
Type string Type of API. Possible values are
graphql
,http
,soap
, andwebsocket
. Defaults tohttp
.- Contact
Api
Contact Args A
contact
block as documented below.- Description string
A description of the API Management API, which may include HTML formatting tags.
- Display
Name string The display name of the API.
- Import
Api
Import Args A
import
block as documented below.- License
Api
License Args A
license
block as documented below.- Name string
The name of the API Management API. Changing this forces a new resource to be created.
- Api
Oauth2Authorization Args An
oauth2_authorization
block as documented below.- Openid
Authentication ApiOpenid Authentication Args An
openid_authentication
block as documented below.- Path string
The Path for this API Management API, which is a relative URL which uniquely identifies this API and all of its resource paths within the API Management Service.
- Protocols []string
A list of protocols the operations in this API can be invoked. Possible values are
http
,https
,ws
, andwss
.- Revision
Description string The description of the API Revision of the API Management API.
- Service
Url string Absolute URL of the backend service implementing this API.
- Soap
Pass boolThrough Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to
false
.soap_pass_through
will be removed in favour of the propertyapi_type
in version 4.0 of the AzureRM Provider- Source
Api stringId The API id of the source API, which could be in format
azurerm_api_management_api.example.id
or in formatazurerm_api_management_api.example.id;rev=1
- Subscription
Key ApiParameter Names Subscription Key Parameter Names Args A
subscription_key_parameter_names
block as documented below.- Subscription
Required bool Should this API require a subscription key? Defaults to
true
.- Terms
Of stringService Url Absolute URL of the Terms of Service for the API.
- Version string
The Version number of this API, if this API is versioned.
- Version
Description string The description of the API Version of the API Management API.
- Version
Set stringId The ID of the Version Set which this API is associated with.
- api
Management StringName The Name of the API Management Service where this API should be created. Changing this forces a new resource to be created.
- resource
Group StringName The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created.
- revision String
The Revision which used for this API. Changing this forces a new resource to be created.
- api
Type String Type of API. Possible values are
graphql
,http
,soap
, andwebsocket
. Defaults tohttp
.- contact
Api
Contact Args A
contact
block as documented below.- description String
A description of the API Management API, which may include HTML formatting tags.
- display
Name String The display name of the API.
- import_
Api
Import Args A
import
block as documented below.- license
Api
License Args A
license
block as documented below.- name String
The name of the API Management API. Changing this forces a new resource to be created.
- Api
Oauth2Authorization Args An
oauth2_authorization
block as documented below.- openid
Authentication ApiOpenid Authentication Args An
openid_authentication
block as documented below.- path String
The Path for this API Management API, which is a relative URL which uniquely identifies this API and all of its resource paths within the API Management Service.
- protocols List<String>
A list of protocols the operations in this API can be invoked. Possible values are
http
,https
,ws
, andwss
.- revision
Description String The description of the API Revision of the API Management API.
- service
Url String Absolute URL of the backend service implementing this API.
- soap
Pass BooleanThrough Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to
false
.soap_pass_through
will be removed in favour of the propertyapi_type
in version 4.0 of the AzureRM Provider- source
Api StringId The API id of the source API, which could be in format
azurerm_api_management_api.example.id
or in formatazurerm_api_management_api.example.id;rev=1
- subscription
Key ApiParameter Names Subscription Key Parameter Names Args A
subscription_key_parameter_names
block as documented below.- subscription
Required Boolean Should this API require a subscription key? Defaults to
true
.- terms
Of StringService Url Absolute URL of the Terms of Service for the API.
- version String
The Version number of this API, if this API is versioned.
- version
Description String The description of the API Version of the API Management API.
- version
Set StringId The ID of the Version Set which this API is associated with.
- api
Management stringName The Name of the API Management Service where this API should be created. Changing this forces a new resource to be created.
- resource
Group stringName The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created.
- revision string
The Revision which used for this API. Changing this forces a new resource to be created.
- api
Type string Type of API. Possible values are
graphql
,http
,soap
, andwebsocket
. Defaults tohttp
.- contact
Api
Contact Args A
contact
block as documented below.- description string
A description of the API Management API, which may include HTML formatting tags.
- display
Name string The display name of the API.
- import
Api
Import Args A
import
block as documented below.- license
Api
License Args A
license
block as documented below.- name string
The name of the API Management API. Changing this forces a new resource to be created.
- Api
Oauth2Authorization Args An
oauth2_authorization
block as documented below.- openid
Authentication ApiOpenid Authentication Args An
openid_authentication
block as documented below.- path string
The Path for this API Management API, which is a relative URL which uniquely identifies this API and all of its resource paths within the API Management Service.
- protocols string[]
A list of protocols the operations in this API can be invoked. Possible values are
http
,https
,ws
, andwss
.- revision
Description string The description of the API Revision of the API Management API.
- service
Url string Absolute URL of the backend service implementing this API.
- soap
Pass booleanThrough Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to
false
.soap_pass_through
will be removed in favour of the propertyapi_type
in version 4.0 of the AzureRM Provider- source
Api stringId The API id of the source API, which could be in format
azurerm_api_management_api.example.id
or in formatazurerm_api_management_api.example.id;rev=1
- subscription
Key ApiParameter Names Subscription Key Parameter Names Args A
subscription_key_parameter_names
block as documented below.- subscription
Required boolean Should this API require a subscription key? Defaults to
true
.- terms
Of stringService Url Absolute URL of the Terms of Service for the API.
- version string
The Version number of this API, if this API is versioned.
- version
Description string The description of the API Version of the API Management API.
- version
Set stringId The ID of the Version Set which this API is associated with.
- api_
management_ strname The Name of the API Management Service where this API should be created. Changing this forces a new resource to be created.
- resource_
group_ strname The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created.
- revision str
The Revision which used for this API. Changing this forces a new resource to be created.
- api_
type str Type of API. Possible values are
graphql
,http
,soap
, andwebsocket
. Defaults tohttp
.- contact
Api
Contact Args A
contact
block as documented below.- description str
A description of the API Management API, which may include HTML formatting tags.
- display_
name str The display name of the API.
- import_
Api
Import Args A
import
block as documented below.- license
Api
License Args A
license
block as documented below.- name str
The name of the API Management API. Changing this forces a new resource to be created.
- Api
Oauth2Authorization Args An
oauth2_authorization
block as documented below.- openid_
authentication ApiOpenid Authentication Args An
openid_authentication
block as documented below.- path str
The Path for this API Management API, which is a relative URL which uniquely identifies this API and all of its resource paths within the API Management Service.
- protocols Sequence[str]
A list of protocols the operations in this API can be invoked. Possible values are
http
,https
,ws
, andwss
.- revision_
description str The description of the API Revision of the API Management API.
- service_
url str Absolute URL of the backend service implementing this API.
- soap_
pass_ boolthrough Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to
false
.soap_pass_through
will be removed in favour of the propertyapi_type
in version 4.0 of the AzureRM Provider- source_
api_ strid The API id of the source API, which could be in format
azurerm_api_management_api.example.id
or in formatazurerm_api_management_api.example.id;rev=1
- subscription_
key_ Apiparameter_ names Subscription Key Parameter Names Args A
subscription_key_parameter_names
block as documented below.- subscription_
required bool Should this API require a subscription key? Defaults to
true
.- terms_
of_ strservice_ url Absolute URL of the Terms of Service for the API.
- version str
The Version number of this API, if this API is versioned.
- version_
description str The description of the API Version of the API Management API.
- version_
set_ strid The ID of the Version Set which this API is associated with.
- api
Management StringName The Name of the API Management Service where this API should be created. Changing this forces a new resource to be created.
- resource
Group StringName The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created.
- revision String
The Revision which used for this API. Changing this forces a new resource to be created.
- api
Type String Type of API. Possible values are
graphql
,http
,soap
, andwebsocket
. Defaults tohttp
.- contact Property Map
A
contact
block as documented below.- description String
A description of the API Management API, which may include HTML formatting tags.
- display
Name String The display name of the API.
- import Property Map
A
import
block as documented below.- license Property Map
A
license
block as documented below.- name String
The name of the API Management API. Changing this forces a new resource to be created.
- Property Map
An
oauth2_authorization
block as documented below.- openid
Authentication Property Map An
openid_authentication
block as documented below.- path String
The Path for this API Management API, which is a relative URL which uniquely identifies this API and all of its resource paths within the API Management Service.
- protocols List<String>
A list of protocols the operations in this API can be invoked. Possible values are
http
,https
,ws
, andwss
.- revision
Description String The description of the API Revision of the API Management API.
- service
Url String Absolute URL of the backend service implementing this API.
- soap
Pass BooleanThrough Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to
false
.soap_pass_through
will be removed in favour of the propertyapi_type
in version 4.0 of the AzureRM Provider- source
Api StringId The API id of the source API, which could be in format
azurerm_api_management_api.example.id
or in formatazurerm_api_management_api.example.id;rev=1
- subscription
Key Property MapParameter Names A
subscription_key_parameter_names
block as documented below.- subscription
Required Boolean Should this API require a subscription key? Defaults to
true
.- terms
Of StringService Url Absolute URL of the Terms of Service for the API.
- version String
The Version number of this API, if this API is versioned.
- version
Description String The description of the API Version of the API Management API.
- version
Set StringId The ID of the Version Set which this API is associated with.
Outputs
All input properties are implicitly available as output properties. Additionally, the Api resource produces the following output properties:
- id str
The provider-assigned unique ID for this managed resource.
- is_
current bool Is this the current API Revision?
- is_
online bool Is this API Revision online/accessible via the Gateway?
Look up Existing Api Resource
Get an existing Api resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ApiState, opts?: CustomResourceOptions): Api
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_management_name: Optional[str] = None,
api_type: Optional[str] = None,
contact: Optional[ApiContactArgs] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
import_: Optional[ApiImportArgs] = None,
is_current: Optional[bool] = None,
is_online: Optional[bool] = None,
license: Optional[ApiLicenseArgs] = None,
name: Optional[str] = None,
oauth2_authorization: Optional[ApiOauth2AuthorizationArgs] = None,
openid_authentication: Optional[ApiOpenidAuthenticationArgs] = None,
path: Optional[str] = None,
protocols: Optional[Sequence[str]] = None,
resource_group_name: Optional[str] = None,
revision: Optional[str] = None,
revision_description: Optional[str] = None,
service_url: Optional[str] = None,
soap_pass_through: Optional[bool] = None,
source_api_id: Optional[str] = None,
subscription_key_parameter_names: Optional[ApiSubscriptionKeyParameterNamesArgs] = None,
subscription_required: Optional[bool] = None,
terms_of_service_url: Optional[str] = None,
version: Optional[str] = None,
version_description: Optional[str] = None,
version_set_id: Optional[str] = None) -> Api
func GetApi(ctx *Context, name string, id IDInput, state *ApiState, opts ...ResourceOption) (*Api, error)
public static Api Get(string name, Input<string> id, ApiState? state, CustomResourceOptions? opts = null)
public static Api get(String name, Output<String> id, ApiState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Api
Management stringName The Name of the API Management Service where this API should be created. Changing this forces a new resource to be created.
- Api
Type string Type of API. Possible values are
graphql
,http
,soap
, andwebsocket
. Defaults tohttp
.- Contact
Api
Contact Args A
contact
block as documented below.- Description string
A description of the API Management API, which may include HTML formatting tags.
- Display
Name string The display name of the API.
- Import
Api
Import Args A
import
block as documented below.- Is
Current bool Is this the current API Revision?
- Is
Online bool Is this API Revision online/accessible via the Gateway?
- License
Api
License Args A
license
block as documented below.- Name string
The name of the API Management API. Changing this forces a new resource to be created.
- Api
Oauth2Authorization Args An
oauth2_authorization
block as documented below.- Openid
Authentication ApiOpenid Authentication Args An
openid_authentication
block as documented below.- Path string
The Path for this API Management API, which is a relative URL which uniquely identifies this API and all of its resource paths within the API Management Service.
- Protocols List<string>
A list of protocols the operations in this API can be invoked. Possible values are
http
,https
,ws
, andwss
.- Resource
Group stringName The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created.
- Revision string
The Revision which used for this API. Changing this forces a new resource to be created.
- Revision
Description string The description of the API Revision of the API Management API.
- Service
Url string Absolute URL of the backend service implementing this API.
- Soap
Pass boolThrough Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to
false
.soap_pass_through
will be removed in favour of the propertyapi_type
in version 4.0 of the AzureRM Provider- Source
Api stringId The API id of the source API, which could be in format
azurerm_api_management_api.example.id
or in formatazurerm_api_management_api.example.id;rev=1
- Subscription
Key ApiParameter Names Subscription Key Parameter Names Args A
subscription_key_parameter_names
block as documented below.- Subscription
Required bool Should this API require a subscription key? Defaults to
true
.- Terms
Of stringService Url Absolute URL of the Terms of Service for the API.
- Version string
The Version number of this API, if this API is versioned.
- Version
Description string The description of the API Version of the API Management API.
- Version
Set stringId The ID of the Version Set which this API is associated with.
- Api
Management stringName The Name of the API Management Service where this API should be created. Changing this forces a new resource to be created.
- Api
Type string Type of API. Possible values are
graphql
,http
,soap
, andwebsocket
. Defaults tohttp
.- Contact
Api
Contact Args A
contact
block as documented below.- Description string
A description of the API Management API, which may include HTML formatting tags.
- Display
Name string The display name of the API.
- Import
Api
Import Args A
import
block as documented below.- Is
Current bool Is this the current API Revision?
- Is
Online bool Is this API Revision online/accessible via the Gateway?
- License
Api
License Args A
license
block as documented below.- Name string
The name of the API Management API. Changing this forces a new resource to be created.
- Api
Oauth2Authorization Args An
oauth2_authorization
block as documented below.- Openid
Authentication ApiOpenid Authentication Args An
openid_authentication
block as documented below.- Path string
The Path for this API Management API, which is a relative URL which uniquely identifies this API and all of its resource paths within the API Management Service.
- Protocols []string
A list of protocols the operations in this API can be invoked. Possible values are
http
,https
,ws
, andwss
.- Resource
Group stringName The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created.
- Revision string
The Revision which used for this API. Changing this forces a new resource to be created.
- Revision
Description string The description of the API Revision of the API Management API.
- Service
Url string Absolute URL of the backend service implementing this API.
- Soap
Pass boolThrough Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to
false
.soap_pass_through
will be removed in favour of the propertyapi_type
in version 4.0 of the AzureRM Provider- Source
Api stringId The API id of the source API, which could be in format
azurerm_api_management_api.example.id
or in formatazurerm_api_management_api.example.id;rev=1
- Subscription
Key ApiParameter Names Subscription Key Parameter Names Args A
subscription_key_parameter_names
block as documented below.- Subscription
Required bool Should this API require a subscription key? Defaults to
true
.- Terms
Of stringService Url Absolute URL of the Terms of Service for the API.
- Version string
The Version number of this API, if this API is versioned.
- Version
Description string The description of the API Version of the API Management API.
- Version
Set stringId The ID of the Version Set which this API is associated with.
- api
Management StringName The Name of the API Management Service where this API should be created. Changing this forces a new resource to be created.
- api
Type String Type of API. Possible values are
graphql
,http
,soap
, andwebsocket
. Defaults tohttp
.- contact
Api
Contact Args A
contact
block as documented below.- description String
A description of the API Management API, which may include HTML formatting tags.
- display
Name String The display name of the API.
- import_
Api
Import Args A
import
block as documented below.- is
Current Boolean Is this the current API Revision?
- is
Online Boolean Is this API Revision online/accessible via the Gateway?
- license
Api
License Args A
license
block as documented below.- name String
The name of the API Management API. Changing this forces a new resource to be created.
- Api
Oauth2Authorization Args An
oauth2_authorization
block as documented below.- openid
Authentication ApiOpenid Authentication Args An
openid_authentication
block as documented below.- path String
The Path for this API Management API, which is a relative URL which uniquely identifies this API and all of its resource paths within the API Management Service.
- protocols List<String>
A list of protocols the operations in this API can be invoked. Possible values are
http
,https
,ws
, andwss
.- resource
Group StringName The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created.
- revision String
The Revision which used for this API. Changing this forces a new resource to be created.
- revision
Description String The description of the API Revision of the API Management API.
- service
Url String Absolute URL of the backend service implementing this API.
- soap
Pass BooleanThrough Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to
false
.soap_pass_through
will be removed in favour of the propertyapi_type
in version 4.0 of the AzureRM Provider- source
Api StringId The API id of the source API, which could be in format
azurerm_api_management_api.example.id
or in formatazurerm_api_management_api.example.id;rev=1
- subscription
Key ApiParameter Names Subscription Key Parameter Names Args A
subscription_key_parameter_names
block as documented below.- subscription
Required Boolean Should this API require a subscription key? Defaults to
true
.- terms
Of StringService Url Absolute URL of the Terms of Service for the API.
- version String
The Version number of this API, if this API is versioned.
- version
Description String The description of the API Version of the API Management API.
- version
Set StringId The ID of the Version Set which this API is associated with.
- api
Management stringName The Name of the API Management Service where this API should be created. Changing this forces a new resource to be created.
- api
Type string Type of API. Possible values are
graphql
,http
,soap
, andwebsocket
. Defaults tohttp
.- contact
Api
Contact Args A
contact
block as documented below.- description string
A description of the API Management API, which may include HTML formatting tags.
- display
Name string The display name of the API.
- import
Api
Import Args A
import
block as documented below.- is
Current boolean Is this the current API Revision?
- is
Online boolean Is this API Revision online/accessible via the Gateway?
- license
Api
License Args A
license
block as documented below.- name string
The name of the API Management API. Changing this forces a new resource to be created.
- Api
Oauth2Authorization Args An
oauth2_authorization
block as documented below.- openid
Authentication ApiOpenid Authentication Args An
openid_authentication
block as documented below.- path string
The Path for this API Management API, which is a relative URL which uniquely identifies this API and all of its resource paths within the API Management Service.
- protocols string[]
A list of protocols the operations in this API can be invoked. Possible values are
http
,https
,ws
, andwss
.- resource
Group stringName The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created.
- revision string
The Revision which used for this API. Changing this forces a new resource to be created.
- revision
Description string The description of the API Revision of the API Management API.
- service
Url string Absolute URL of the backend service implementing this API.
- soap
Pass booleanThrough Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to
false
.soap_pass_through
will be removed in favour of the propertyapi_type
in version 4.0 of the AzureRM Provider- source
Api stringId The API id of the source API, which could be in format
azurerm_api_management_api.example.id
or in formatazurerm_api_management_api.example.id;rev=1
- subscription
Key ApiParameter Names Subscription Key Parameter Names Args A
subscription_key_parameter_names
block as documented below.- subscription
Required boolean Should this API require a subscription key? Defaults to
true
.- terms
Of stringService Url Absolute URL of the Terms of Service for the API.
- version string
The Version number of this API, if this API is versioned.
- version
Description string The description of the API Version of the API Management API.
- version
Set stringId The ID of the Version Set which this API is associated with.
- api_
management_ strname The Name of the API Management Service where this API should be created. Changing this forces a new resource to be created.
- api_
type str Type of API. Possible values are
graphql
,http
,soap
, andwebsocket
. Defaults tohttp
.- contact
Api
Contact Args A
contact
block as documented below.- description str
A description of the API Management API, which may include HTML formatting tags.
- display_
name str The display name of the API.
- import_
Api
Import Args A
import
block as documented below.- is_
current bool Is this the current API Revision?
- is_
online bool Is this API Revision online/accessible via the Gateway?
- license
Api
License Args A
license
block as documented below.- name str
The name of the API Management API. Changing this forces a new resource to be created.
- Api
Oauth2Authorization Args An
oauth2_authorization
block as documented below.- openid_
authentication ApiOpenid Authentication Args An
openid_authentication
block as documented below.- path str
The Path for this API Management API, which is a relative URL which uniquely identifies this API and all of its resource paths within the API Management Service.
- protocols Sequence[str]
A list of protocols the operations in this API can be invoked. Possible values are
http
,https
,ws
, andwss
.- resource_
group_ strname The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created.
- revision str
The Revision which used for this API. Changing this forces a new resource to be created.
- revision_
description str The description of the API Revision of the API Management API.
- service_
url str Absolute URL of the backend service implementing this API.
- soap_
pass_ boolthrough Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to
false
.soap_pass_through
will be removed in favour of the propertyapi_type
in version 4.0 of the AzureRM Provider- source_
api_ strid The API id of the source API, which could be in format
azurerm_api_management_api.example.id
or in formatazurerm_api_management_api.example.id;rev=1
- subscription_
key_ Apiparameter_ names Subscription Key Parameter Names Args A
subscription_key_parameter_names
block as documented below.- subscription_
required bool Should this API require a subscription key? Defaults to
true
.- terms_
of_ strservice_ url Absolute URL of the Terms of Service for the API.
- version str
The Version number of this API, if this API is versioned.
- version_
description str The description of the API Version of the API Management API.
- version_
set_ strid The ID of the Version Set which this API is associated with.
- api
Management StringName The Name of the API Management Service where this API should be created. Changing this forces a new resource to be created.
- api
Type String Type of API. Possible values are
graphql
,http
,soap
, andwebsocket
. Defaults tohttp
.- contact Property Map
A
contact
block as documented below.- description String
A description of the API Management API, which may include HTML formatting tags.
- display
Name String The display name of the API.
- import Property Map
A
import
block as documented below.- is
Current Boolean Is this the current API Revision?
- is
Online Boolean Is this API Revision online/accessible via the Gateway?
- license Property Map
A
license
block as documented below.- name String
The name of the API Management API. Changing this forces a new resource to be created.
- Property Map
An
oauth2_authorization
block as documented below.- openid
Authentication Property Map An
openid_authentication
block as documented below.- path String
The Path for this API Management API, which is a relative URL which uniquely identifies this API and all of its resource paths within the API Management Service.
- protocols List<String>
A list of protocols the operations in this API can be invoked. Possible values are
http
,https
,ws
, andwss
.- resource
Group StringName The Name of the Resource Group where the API Management API exists. Changing this forces a new resource to be created.
- revision String
The Revision which used for this API. Changing this forces a new resource to be created.
- revision
Description String The description of the API Revision of the API Management API.
- service
Url String Absolute URL of the backend service implementing this API.
- soap
Pass BooleanThrough Should this API expose a SOAP frontend, rather than a HTTP frontend? Defaults to
false
.soap_pass_through
will be removed in favour of the propertyapi_type
in version 4.0 of the AzureRM Provider- source
Api StringId The API id of the source API, which could be in format
azurerm_api_management_api.example.id
or in formatazurerm_api_management_api.example.id;rev=1
- subscription
Key Property MapParameter Names A
subscription_key_parameter_names
block as documented below.- subscription
Required Boolean Should this API require a subscription key? Defaults to
true
.- terms
Of StringService Url Absolute URL of the Terms of Service for the API.
- version String
The Version number of this API, if this API is versioned.
- version
Description String The description of the API Version of the API Management API.
- version
Set StringId The ID of the Version Set which this API is associated with.
Supporting Types
ApiContact
ApiImport
- Content
Format string The format of the content from which the API Definition should be imported. Possible values are:
openapi
,openapi+json
,openapi+json-link
,openapi-link
,swagger-json
,swagger-link-json
,wadl-link-json
,wadl-xml
,wsdl
andwsdl-link
.- Content
Value string The Content from which the API Definition should be imported. When a
content_format
of*-link-*
is specified this must be a URL, otherwise this must be defined inline.- Wsdl
Selector ApiImport Wsdl Selector A
wsdl_selector
block as defined below, which allows you to limit the import of a WSDL to only a subset of the document. This can only be specified whencontent_format
iswsdl
orwsdl-link
.
- Content
Format string The format of the content from which the API Definition should be imported. Possible values are:
openapi
,openapi+json
,openapi+json-link
,openapi-link
,swagger-json
,swagger-link-json
,wadl-link-json
,wadl-xml
,wsdl
andwsdl-link
.- Content
Value string The Content from which the API Definition should be imported. When a
content_format
of*-link-*
is specified this must be a URL, otherwise this must be defined inline.- Wsdl
Selector ApiImport Wsdl Selector A
wsdl_selector
block as defined below, which allows you to limit the import of a WSDL to only a subset of the document. This can only be specified whencontent_format
iswsdl
orwsdl-link
.
- content
Format String The format of the content from which the API Definition should be imported. Possible values are:
openapi
,openapi+json
,openapi+json-link
,openapi-link
,swagger-json
,swagger-link-json
,wadl-link-json
,wadl-xml
,wsdl
andwsdl-link
.- content
Value String The Content from which the API Definition should be imported. When a
content_format
of*-link-*
is specified this must be a URL, otherwise this must be defined inline.- wsdl
Selector ApiImport Wsdl Selector A
wsdl_selector
block as defined below, which allows you to limit the import of a WSDL to only a subset of the document. This can only be specified whencontent_format
iswsdl
orwsdl-link
.
- content
Format string The format of the content from which the API Definition should be imported. Possible values are:
openapi
,openapi+json
,openapi+json-link
,openapi-link
,swagger-json
,swagger-link-json
,wadl-link-json
,wadl-xml
,wsdl
andwsdl-link
.- content
Value string The Content from which the API Definition should be imported. When a
content_format
of*-link-*
is specified this must be a URL, otherwise this must be defined inline.- wsdl
Selector ApiImport Wsdl Selector A
wsdl_selector
block as defined below, which allows you to limit the import of a WSDL to only a subset of the document. This can only be specified whencontent_format
iswsdl
orwsdl-link
.
- content_
format str The format of the content from which the API Definition should be imported. Possible values are:
openapi
,openapi+json
,openapi+json-link
,openapi-link
,swagger-json
,swagger-link-json
,wadl-link-json
,wadl-xml
,wsdl
andwsdl-link
.- content_
value str The Content from which the API Definition should be imported. When a
content_format
of*-link-*
is specified this must be a URL, otherwise this must be defined inline.- wsdl_
selector ApiImport Wsdl Selector A
wsdl_selector
block as defined below, which allows you to limit the import of a WSDL to only a subset of the document. This can only be specified whencontent_format
iswsdl
orwsdl-link
.
- content
Format String The format of the content from which the API Definition should be imported. Possible values are:
openapi
,openapi+json
,openapi+json-link
,openapi-link
,swagger-json
,swagger-link-json
,wadl-link-json
,wadl-xml
,wsdl
andwsdl-link
.- content
Value String The Content from which the API Definition should be imported. When a
content_format
of*-link-*
is specified this must be a URL, otherwise this must be defined inline.- wsdl
Selector Property Map A
wsdl_selector
block as defined below, which allows you to limit the import of a WSDL to only a subset of the document. This can only be specified whencontent_format
iswsdl
orwsdl-link
.
ApiImportWsdlSelector
- Endpoint
Name string The name of endpoint (port) to import from WSDL.
- Service
Name string The name of service to import from WSDL.
- Endpoint
Name string The name of endpoint (port) to import from WSDL.
- Service
Name string The name of service to import from WSDL.
- endpoint
Name String The name of endpoint (port) to import from WSDL.
- service
Name String The name of service to import from WSDL.
- endpoint
Name string The name of endpoint (port) to import from WSDL.
- service
Name string The name of service to import from WSDL.
- endpoint_
name str The name of endpoint (port) to import from WSDL.
- service_
name str The name of service to import from WSDL.
- endpoint
Name String The name of endpoint (port) to import from WSDL.
- service
Name String The name of service to import from WSDL.
ApiLicense
ApiOauth2Authorization
- string
OAuth authorization server identifier. The name of an OAuth2 Authorization Server.
- Scope string
Operations scope.
- string
OAuth authorization server identifier. The name of an OAuth2 Authorization Server.
- Scope string
Operations scope.
- String
OAuth authorization server identifier. The name of an OAuth2 Authorization Server.
- scope String
Operations scope.
- string
OAuth authorization server identifier. The name of an OAuth2 Authorization Server.
- scope string
Operations scope.
- str
OAuth authorization server identifier. The name of an OAuth2 Authorization Server.
- scope str
Operations scope.
- String
OAuth authorization server identifier. The name of an OAuth2 Authorization Server.
- scope String
Operations scope.
ApiOpenidAuthentication
- Openid
Provider stringName OpenID Connect provider identifier. The name of an OpenID Connect Provider.
- Bearer
Token List<string>Sending Methods How to send token to the server. A list of zero or more methods. Valid values are
authorizationHeader
andquery
.
- Openid
Provider stringName OpenID Connect provider identifier. The name of an OpenID Connect Provider.
- Bearer
Token []stringSending Methods How to send token to the server. A list of zero or more methods. Valid values are
authorizationHeader
andquery
.
- openid
Provider StringName OpenID Connect provider identifier. The name of an OpenID Connect Provider.
- bearer
Token List<String>Sending Methods How to send token to the server. A list of zero or more methods. Valid values are
authorizationHeader
andquery
.
- openid
Provider stringName OpenID Connect provider identifier. The name of an OpenID Connect Provider.
- bearer
Token string[]Sending Methods How to send token to the server. A list of zero or more methods. Valid values are
authorizationHeader
andquery
.
- openid_
provider_ strname OpenID Connect provider identifier. The name of an OpenID Connect Provider.
- bearer_
token_ Sequence[str]sending_ methods How to send token to the server. A list of zero or more methods. Valid values are
authorizationHeader
andquery
.
- openid
Provider StringName OpenID Connect provider identifier. The name of an OpenID Connect Provider.
- bearer
Token List<String>Sending Methods How to send token to the server. A list of zero or more methods. Valid values are
authorizationHeader
andquery
.
ApiSubscriptionKeyParameterNames
Import
API Management API’s can be imported using the resource id
, e.g.
$ pulumi import azure:apimanagement/api:Api example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/apis/api1
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.