azure-native.appplatform.ApiPortal
API portal resource
Uses Azure REST API version 2024-01-01-preview. In version 2.x of the Azure Native provider, it used API version 2023-05-01-preview.
Other available API versions: 2023-05-01-preview, 2023-07-01-preview, 2023-09-01-preview, 2023-11-01-preview, 2023-12-01, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native appplatform [ApiVersion]. See the version guide for details.
Example Usage
ApiPortals_CreateOrUpdate
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var apiPortal = new AzureNative.AppPlatform.ApiPortal("apiPortal", new()
    {
        ApiPortalName = "default",
        Properties = new AzureNative.AppPlatform.Inputs.ApiPortalPropertiesArgs
        {
            ApiTryOutEnabledState = AzureNative.AppPlatform.ApiPortalApiTryOutEnabledState.Enabled,
            GatewayIds = new[]
            {
                "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default",
            },
            Public = true,
        },
        ResourceGroupName = "myResourceGroup",
        ServiceName = "myservice",
        Sku = new AzureNative.AppPlatform.Inputs.SkuArgs
        {
            Capacity = 2,
            Name = "E0",
            Tier = "Enterprise",
        },
    });
});
package main
import (
	appplatform "github.com/pulumi/pulumi-azure-native-sdk/appplatform/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := appplatform.NewApiPortal(ctx, "apiPortal", &appplatform.ApiPortalArgs{
			ApiPortalName: pulumi.String("default"),
			Properties: &appplatform.ApiPortalPropertiesArgs{
				ApiTryOutEnabledState: pulumi.String(appplatform.ApiPortalApiTryOutEnabledStateEnabled),
				GatewayIds: pulumi.StringArray{
					pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default"),
				},
				Public: pulumi.Bool(true),
			},
			ResourceGroupName: pulumi.String("myResourceGroup"),
			ServiceName:       pulumi.String("myservice"),
			Sku: &appplatform.SkuArgs{
				Capacity: pulumi.Int(2),
				Name:     pulumi.String("E0"),
				Tier:     pulumi.String("Enterprise"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.appplatform.ApiPortal;
import com.pulumi.azurenative.appplatform.ApiPortalArgs;
import com.pulumi.azurenative.appplatform.inputs.ApiPortalPropertiesArgs;
import com.pulumi.azurenative.appplatform.inputs.SkuArgs;
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 apiPortal = new ApiPortal("apiPortal", ApiPortalArgs.builder()
            .apiPortalName("default")
            .properties(ApiPortalPropertiesArgs.builder()
                .apiTryOutEnabledState("Enabled")
                .gatewayIds("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default")
                .public_(true)
                .build())
            .resourceGroupName("myResourceGroup")
            .serviceName("myservice")
            .sku(SkuArgs.builder()
                .capacity(2)
                .name("E0")
                .tier("Enterprise")
                .build())
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const apiPortal = new azure_native.appplatform.ApiPortal("apiPortal", {
    apiPortalName: "default",
    properties: {
        apiTryOutEnabledState: azure_native.appplatform.ApiPortalApiTryOutEnabledState.Enabled,
        gatewayIds: ["/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default"],
        "public": true,
    },
    resourceGroupName: "myResourceGroup",
    serviceName: "myservice",
    sku: {
        capacity: 2,
        name: "E0",
        tier: "Enterprise",
    },
});
import pulumi
import pulumi_azure_native as azure_native
api_portal = azure_native.appplatform.ApiPortal("apiPortal",
    api_portal_name="default",
    properties={
        "api_try_out_enabled_state": azure_native.appplatform.ApiPortalApiTryOutEnabledState.ENABLED,
        "gateway_ids": ["/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default"],
        "public": True,
    },
    resource_group_name="myResourceGroup",
    service_name="myservice",
    sku={
        "capacity": 2,
        "name": "E0",
        "tier": "Enterprise",
    })
resources:
  apiPortal:
    type: azure-native:appplatform:ApiPortal
    properties:
      apiPortalName: default
      properties:
        apiTryOutEnabledState: Enabled
        gatewayIds:
          - /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default
        public: true
      resourceGroupName: myResourceGroup
      serviceName: myservice
      sku:
        capacity: 2
        name: E0
        tier: Enterprise
Create ApiPortal Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ApiPortal(name: string, args: ApiPortalArgs, opts?: CustomResourceOptions);@overload
def ApiPortal(resource_name: str,
              args: ApiPortalArgs,
              opts: Optional[ResourceOptions] = None)
@overload
def ApiPortal(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              resource_group_name: Optional[str] = None,
              service_name: Optional[str] = None,
              api_portal_name: Optional[str] = None,
              properties: Optional[ApiPortalPropertiesArgs] = None,
              sku: Optional[SkuArgs] = None)func NewApiPortal(ctx *Context, name string, args ApiPortalArgs, opts ...ResourceOption) (*ApiPortal, error)public ApiPortal(string name, ApiPortalArgs args, CustomResourceOptions? opts = null)
public ApiPortal(String name, ApiPortalArgs args)
public ApiPortal(String name, ApiPortalArgs args, CustomResourceOptions options)
type: azure-native:appplatform:ApiPortal
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ApiPortalArgs
- 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 ApiPortalArgs
- 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 ApiPortalArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiPortalArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApiPortalArgs
- 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 apiPortalResource = new AzureNative.AppPlatform.ApiPortal("apiPortalResource", new()
{
    ResourceGroupName = "string",
    ServiceName = "string",
    ApiPortalName = "string",
    Properties = new AzureNative.AppPlatform.Inputs.ApiPortalPropertiesArgs
    {
        ApiTryOutEnabledState = "string",
        GatewayIds = new[]
        {
            "string",
        },
        HttpsOnly = false,
        Public = false,
        SourceUrls = new[]
        {
            "string",
        },
        SsoProperties = new AzureNative.AppPlatform.Inputs.SsoPropertiesArgs
        {
            ClientId = "string",
            ClientSecret = "string",
            IssuerUri = "string",
            Scope = new[]
            {
                "string",
            },
        },
    },
    Sku = new AzureNative.AppPlatform.Inputs.SkuArgs
    {
        Capacity = 0,
        Name = "string",
        Tier = "string",
    },
});
example, err := appplatform.NewApiPortal(ctx, "apiPortalResource", &appplatform.ApiPortalArgs{
	ResourceGroupName: pulumi.String("string"),
	ServiceName:       pulumi.String("string"),
	ApiPortalName:     pulumi.String("string"),
	Properties: &appplatform.ApiPortalPropertiesArgs{
		ApiTryOutEnabledState: pulumi.String("string"),
		GatewayIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		HttpsOnly: pulumi.Bool(false),
		Public:    pulumi.Bool(false),
		SourceUrls: pulumi.StringArray{
			pulumi.String("string"),
		},
		SsoProperties: &appplatform.SsoPropertiesArgs{
			ClientId:     pulumi.String("string"),
			ClientSecret: pulumi.String("string"),
			IssuerUri:    pulumi.String("string"),
			Scope: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Sku: &appplatform.SkuArgs{
		Capacity: pulumi.Int(0),
		Name:     pulumi.String("string"),
		Tier:     pulumi.String("string"),
	},
})
var apiPortalResource = new ApiPortal("apiPortalResource", ApiPortalArgs.builder()
    .resourceGroupName("string")
    .serviceName("string")
    .apiPortalName("string")
    .properties(ApiPortalPropertiesArgs.builder()
        .apiTryOutEnabledState("string")
        .gatewayIds("string")
        .httpsOnly(false)
        .public_(false)
        .sourceUrls("string")
        .ssoProperties(SsoPropertiesArgs.builder()
            .clientId("string")
            .clientSecret("string")
            .issuerUri("string")
            .scope("string")
            .build())
        .build())
    .sku(SkuArgs.builder()
        .capacity(0)
        .name("string")
        .tier("string")
        .build())
    .build());
api_portal_resource = azure_native.appplatform.ApiPortal("apiPortalResource",
    resource_group_name="string",
    service_name="string",
    api_portal_name="string",
    properties={
        "api_try_out_enabled_state": "string",
        "gateway_ids": ["string"],
        "https_only": False,
        "public": False,
        "source_urls": ["string"],
        "sso_properties": {
            "client_id": "string",
            "client_secret": "string",
            "issuer_uri": "string",
            "scope": ["string"],
        },
    },
    sku={
        "capacity": 0,
        "name": "string",
        "tier": "string",
    })
const apiPortalResource = new azure_native.appplatform.ApiPortal("apiPortalResource", {
    resourceGroupName: "string",
    serviceName: "string",
    apiPortalName: "string",
    properties: {
        apiTryOutEnabledState: "string",
        gatewayIds: ["string"],
        httpsOnly: false,
        "public": false,
        sourceUrls: ["string"],
        ssoProperties: {
            clientId: "string",
            clientSecret: "string",
            issuerUri: "string",
            scope: ["string"],
        },
    },
    sku: {
        capacity: 0,
        name: "string",
        tier: "string",
    },
});
type: azure-native:appplatform:ApiPortal
properties:
    apiPortalName: string
    properties:
        apiTryOutEnabledState: string
        gatewayIds:
            - string
        httpsOnly: false
        public: false
        sourceUrls:
            - string
        ssoProperties:
            clientId: string
            clientSecret: string
            issuerUri: string
            scope:
                - string
    resourceGroupName: string
    serviceName: string
    sku:
        capacity: 0
        name: string
        tier: string
ApiPortal 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 ApiPortal resource accepts the following input properties:
- ResourceGroup stringName 
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- ServiceName string
- The name of the Service resource.
- ApiPortal stringName 
- The name of API portal.
- Properties
Pulumi.Azure Native. App Platform. Inputs. Api Portal Properties 
- API portal properties payload
- Sku
Pulumi.Azure Native. App Platform. Inputs. Sku 
- Sku of the API portal resource
- ResourceGroup stringName 
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- ServiceName string
- The name of the Service resource.
- ApiPortal stringName 
- The name of API portal.
- Properties
ApiPortal Properties Args 
- API portal properties payload
- Sku
SkuArgs 
- Sku of the API portal resource
- resourceGroup StringName 
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName String
- The name of the Service resource.
- apiPortal StringName 
- The name of API portal.
- properties
ApiPortal Properties 
- API portal properties payload
- sku Sku
- Sku of the API portal resource
- resourceGroup stringName 
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName string
- The name of the Service resource.
- apiPortal stringName 
- The name of API portal.
- properties
ApiPortal Properties 
- API portal properties payload
- sku Sku
- Sku of the API portal resource
- resource_group_ strname 
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- service_name str
- The name of the Service resource.
- api_portal_ strname 
- The name of API portal.
- properties
ApiPortal Properties Args 
- API portal properties payload
- sku
SkuArgs 
- Sku of the API portal resource
- resourceGroup StringName 
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName String
- The name of the Service resource.
- apiPortal StringName 
- The name of API portal.
- properties Property Map
- API portal properties payload
- sku Property Map
- Sku of the API portal resource
Outputs
All input properties are implicitly available as output properties. Additionally, the ApiPortal resource produces the following output properties:
- AzureApi stringVersion 
- The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource.
- SystemData Pulumi.Azure Native. App Platform. Outputs. System Data Response 
- Metadata pertaining to creation and last modification of the resource.
- Type string
- The type of the resource.
- AzureApi stringVersion 
- The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource.
- SystemData SystemData Response 
- Metadata pertaining to creation and last modification of the resource.
- Type string
- The type of the resource.
- azureApi StringVersion 
- The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource.
- systemData SystemData Response 
- Metadata pertaining to creation and last modification of the resource.
- type String
- The type of the resource.
- azureApi stringVersion 
- The Azure API version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource.
- systemData SystemData Response 
- Metadata pertaining to creation and last modification of the resource.
- type string
- The type of the resource.
- azure_api_ strversion 
- The Azure API version of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource.
- system_data SystemData Response 
- Metadata pertaining to creation and last modification of the resource.
- type str
- The type of the resource.
- azureApi StringVersion 
- The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource.
- systemData Property Map
- Metadata pertaining to creation and last modification of the resource.
- type String
- The type of the resource.
Supporting Types
ApiPortalApiTryOutEnabledState, ApiPortalApiTryOutEnabledStateArgs              
- Enabled
- Enabled
- Disabled
- Disabled
- ApiPortal Api Try Out Enabled State Enabled 
- Enabled
- ApiPortal Api Try Out Enabled State Disabled 
- Disabled
- Enabled
- Enabled
- Disabled
- Disabled
- Enabled
- Enabled
- Disabled
- Disabled
- ENABLED
- Enabled
- DISABLED
- Disabled
- "Enabled"
- Enabled
- "Disabled"
- Disabled
ApiPortalInstanceResponse, ApiPortalInstanceResponseArgs        
Collection of instances belong to the API portalApiPortalProperties, ApiPortalPropertiesArgs      
API portal properties payload- ApiTry string | Pulumi.Out Enabled State Azure Native. App Platform. Api Portal Api Try Out Enabled State 
- Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.
- GatewayIds List<string>
- The array of resource Ids of gateway to integrate with API portal.
- HttpsOnly bool
- Indicate if only https is allowed.
- Public bool
- Indicates whether the API portal exposes endpoint.
- SourceUrls List<string>
- Collection of OpenAPI source URL locations.
- SsoProperties Pulumi.Azure Native. App Platform. Inputs. Sso Properties 
- Single sign-on related configuration
- ApiTry string | ApiOut Enabled State Portal Api Try Out Enabled State 
- Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.
- GatewayIds []string
- The array of resource Ids of gateway to integrate with API portal.
- HttpsOnly bool
- Indicate if only https is allowed.
- Public bool
- Indicates whether the API portal exposes endpoint.
- SourceUrls []string
- Collection of OpenAPI source URL locations.
- SsoProperties SsoProperties 
- Single sign-on related configuration
- apiTry String | ApiOut Enabled State Portal Api Try Out Enabled State 
- Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.
- gatewayIds List<String>
- The array of resource Ids of gateway to integrate with API portal.
- httpsOnly Boolean
- Indicate if only https is allowed.
- public_ Boolean
- Indicates whether the API portal exposes endpoint.
- sourceUrls List<String>
- Collection of OpenAPI source URL locations.
- ssoProperties SsoProperties 
- Single sign-on related configuration
- apiTry string | ApiOut Enabled State Portal Api Try Out Enabled State 
- Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.
- gatewayIds string[]
- The array of resource Ids of gateway to integrate with API portal.
- httpsOnly boolean
- Indicate if only https is allowed.
- public boolean
- Indicates whether the API portal exposes endpoint.
- sourceUrls string[]
- Collection of OpenAPI source URL locations.
- ssoProperties SsoProperties 
- Single sign-on related configuration
- api_try_ str | Apiout_ enabled_ state Portal Api Try Out Enabled State 
- Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.
- gateway_ids Sequence[str]
- The array of resource Ids of gateway to integrate with API portal.
- https_only bool
- Indicate if only https is allowed.
- public bool
- Indicates whether the API portal exposes endpoint.
- source_urls Sequence[str]
- Collection of OpenAPI source URL locations.
- sso_properties SsoProperties 
- Single sign-on related configuration
- apiTry String | "Enabled" | "Disabled"Out Enabled State 
- Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.
- gatewayIds List<String>
- The array of resource Ids of gateway to integrate with API portal.
- httpsOnly Boolean
- Indicate if only https is allowed.
- public Boolean
- Indicates whether the API portal exposes endpoint.
- sourceUrls List<String>
- Collection of OpenAPI source URL locations.
- ssoProperties Property Map
- Single sign-on related configuration
ApiPortalPropertiesResponse, ApiPortalPropertiesResponseArgs        
API portal properties payload- Instances
List<Pulumi.Azure Native. App Platform. Inputs. Api Portal Instance Response> 
- Collection of instances belong to API portal.
- ProvisioningState string
- State of the API portal.
- ResourceRequests Pulumi.Azure Native. App Platform. Inputs. Api Portal Resource Requests Response 
- The requested resource quantity for required CPU and Memory.
- Url string
- URL of the API portal, exposed when 'public' is true.
- ApiTry stringOut Enabled State 
- Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.
- GatewayIds List<string>
- The array of resource Ids of gateway to integrate with API portal.
- HttpsOnly bool
- Indicate if only https is allowed.
- Public bool
- Indicates whether the API portal exposes endpoint.
- SourceUrls List<string>
- Collection of OpenAPI source URL locations.
- SsoProperties Pulumi.Azure Native. App Platform. Inputs. Sso Properties Response 
- Single sign-on related configuration
- Instances
[]ApiPortal Instance Response 
- Collection of instances belong to API portal.
- ProvisioningState string
- State of the API portal.
- ResourceRequests ApiPortal Resource Requests Response 
- The requested resource quantity for required CPU and Memory.
- Url string
- URL of the API portal, exposed when 'public' is true.
- ApiTry stringOut Enabled State 
- Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.
- GatewayIds []string
- The array of resource Ids of gateway to integrate with API portal.
- HttpsOnly bool
- Indicate if only https is allowed.
- Public bool
- Indicates whether the API portal exposes endpoint.
- SourceUrls []string
- Collection of OpenAPI source URL locations.
- SsoProperties SsoProperties Response 
- Single sign-on related configuration
- instances
List<ApiPortal Instance Response> 
- Collection of instances belong to API portal.
- provisioningState String
- State of the API portal.
- resourceRequests ApiPortal Resource Requests Response 
- The requested resource quantity for required CPU and Memory.
- url String
- URL of the API portal, exposed when 'public' is true.
- apiTry StringOut Enabled State 
- Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.
- gatewayIds List<String>
- The array of resource Ids of gateway to integrate with API portal.
- httpsOnly Boolean
- Indicate if only https is allowed.
- public_ Boolean
- Indicates whether the API portal exposes endpoint.
- sourceUrls List<String>
- Collection of OpenAPI source URL locations.
- ssoProperties SsoProperties Response 
- Single sign-on related configuration
- instances
ApiPortal Instance Response[] 
- Collection of instances belong to API portal.
- provisioningState string
- State of the API portal.
- resourceRequests ApiPortal Resource Requests Response 
- The requested resource quantity for required CPU and Memory.
- url string
- URL of the API portal, exposed when 'public' is true.
- apiTry stringOut Enabled State 
- Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.
- gatewayIds string[]
- The array of resource Ids of gateway to integrate with API portal.
- httpsOnly boolean
- Indicate if only https is allowed.
- public boolean
- Indicates whether the API portal exposes endpoint.
- sourceUrls string[]
- Collection of OpenAPI source URL locations.
- ssoProperties SsoProperties Response 
- Single sign-on related configuration
- instances
Sequence[ApiPortal Instance Response] 
- Collection of instances belong to API portal.
- provisioning_state str
- State of the API portal.
- resource_requests ApiPortal Resource Requests Response 
- The requested resource quantity for required CPU and Memory.
- url str
- URL of the API portal, exposed when 'public' is true.
- api_try_ strout_ enabled_ state 
- Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.
- gateway_ids Sequence[str]
- The array of resource Ids of gateway to integrate with API portal.
- https_only bool
- Indicate if only https is allowed.
- public bool
- Indicates whether the API portal exposes endpoint.
- source_urls Sequence[str]
- Collection of OpenAPI source URL locations.
- sso_properties SsoProperties Response 
- Single sign-on related configuration
- instances List<Property Map>
- Collection of instances belong to API portal.
- provisioningState String
- State of the API portal.
- resourceRequests Property Map
- The requested resource quantity for required CPU and Memory.
- url String
- URL of the API portal, exposed when 'public' is true.
- apiTry StringOut Enabled State 
- Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.
- gatewayIds List<String>
- The array of resource Ids of gateway to integrate with API portal.
- httpsOnly Boolean
- Indicate if only https is allowed.
- public Boolean
- Indicates whether the API portal exposes endpoint.
- sourceUrls List<String>
- Collection of OpenAPI source URL locations.
- ssoProperties Property Map
- Single sign-on related configuration
ApiPortalResourceRequestsResponse, ApiPortalResourceRequestsResponseArgs          
Resource requests of the API portalSku, SkuArgs  
Sku of Azure Spring AppsSkuResponse, SkuResponseArgs    
Sku of Azure Spring AppsSsoProperties, SsoPropertiesArgs    
Single sign-on related configuration- ClientId string
- The public identifier for the application
- ClientSecret string
- The secret known only to the application and the authorization server
- IssuerUri string
- The URI of Issuer Identifier
- Scope List<string>
- It defines the specific actions applications can be allowed to do on a user's behalf
- ClientId string
- The public identifier for the application
- ClientSecret string
- The secret known only to the application and the authorization server
- IssuerUri string
- The URI of Issuer Identifier
- Scope []string
- It defines the specific actions applications can be allowed to do on a user's behalf
- clientId String
- The public identifier for the application
- clientSecret String
- The secret known only to the application and the authorization server
- issuerUri String
- The URI of Issuer Identifier
- scope List<String>
- It defines the specific actions applications can be allowed to do on a user's behalf
- clientId string
- The public identifier for the application
- clientSecret string
- The secret known only to the application and the authorization server
- issuerUri string
- The URI of Issuer Identifier
- scope string[]
- It defines the specific actions applications can be allowed to do on a user's behalf
- client_id str
- The public identifier for the application
- client_secret str
- The secret known only to the application and the authorization server
- issuer_uri str
- The URI of Issuer Identifier
- scope Sequence[str]
- It defines the specific actions applications can be allowed to do on a user's behalf
- clientId String
- The public identifier for the application
- clientSecret String
- The secret known only to the application and the authorization server
- issuerUri String
- The URI of Issuer Identifier
- scope List<String>
- It defines the specific actions applications can be allowed to do on a user's behalf
SsoPropertiesResponse, SsoPropertiesResponseArgs      
Single sign-on related configuration- ClientId string
- The public identifier for the application
- ClientSecret string
- The secret known only to the application and the authorization server
- IssuerUri string
- The URI of Issuer Identifier
- Scope List<string>
- It defines the specific actions applications can be allowed to do on a user's behalf
- ClientId string
- The public identifier for the application
- ClientSecret string
- The secret known only to the application and the authorization server
- IssuerUri string
- The URI of Issuer Identifier
- Scope []string
- It defines the specific actions applications can be allowed to do on a user's behalf
- clientId String
- The public identifier for the application
- clientSecret String
- The secret known only to the application and the authorization server
- issuerUri String
- The URI of Issuer Identifier
- scope List<String>
- It defines the specific actions applications can be allowed to do on a user's behalf
- clientId string
- The public identifier for the application
- clientSecret string
- The secret known only to the application and the authorization server
- issuerUri string
- The URI of Issuer Identifier
- scope string[]
- It defines the specific actions applications can be allowed to do on a user's behalf
- client_id str
- The public identifier for the application
- client_secret str
- The secret known only to the application and the authorization server
- issuer_uri str
- The URI of Issuer Identifier
- scope Sequence[str]
- It defines the specific actions applications can be allowed to do on a user's behalf
- clientId String
- The public identifier for the application
- clientSecret String
- The secret known only to the application and the authorization server
- issuerUri String
- The URI of Issuer Identifier
- scope List<String>
- It defines the specific actions applications can be allowed to do on a user's behalf
SystemDataResponse, SystemDataResponseArgs      
Metadata pertaining to creation and last modification of the resource.- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource modification (UTC).
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource modification (UTC).
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource modification (UTC).
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
- createdAt string
- The timestamp of resource creation (UTC).
- createdBy string
- The identity that created the resource.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource modification (UTC).
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- The type of identity that last modified the resource.
- created_at str
- The timestamp of resource creation (UTC).
- created_by str
- The identity that created the resource.
- created_by_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource modification (UTC).
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- The type of identity that last modified the resource.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource modification (UTC).
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:appplatform:ApiPortal default /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
