Azure Native

v1.79.2 published on Thursday, Sep 29, 2022 by Pulumi

ApiPortal

API portal resource API Version: 2022-01-01-preview.

Example Usage

ApiPortals_CreateOrUpdate

using System.Collections.Generic;
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
        {
            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/go/azure/appplatform"
	"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{
				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 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(Map.ofEntries(
                Map.entry("gatewayIds", "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default"),
                Map.entry("public", true)
            ))
            .resourceGroupName("myResourceGroup")
            .serviceName("myservice")
            .sku(Map.ofEntries(
                Map.entry("capacity", 2),
                Map.entry("name", "E0"),
                Map.entry("tier", "Enterprise")
            ))
            .build());

    }
}
import pulumi
import pulumi_azure_native as azure_native

api_portal = azure_native.appplatform.ApiPortal("apiPortal",
    api_portal_name="default",
    properties=azure_native.appplatform.ApiPortalPropertiesArgs(
        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=azure_native.appplatform.SkuArgs(
        capacity=2,
        name="E0",
        tier="Enterprise",
    ))
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: {
        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",
    },
});
resources:
  apiPortal:
    type: azure-native:appplatform:ApiPortal
    properties:
      apiPortalName: default
      properties:
        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 a ApiPortal Resource

new ApiPortal(name: string, args: ApiPortalArgs, opts?: CustomResourceOptions);
@overload
def ApiPortal(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              api_portal_name: Optional[str] = None,
              properties: Optional[ApiPortalPropertiesArgs] = None,
              resource_group_name: Optional[str] = None,
              service_name: Optional[str] = None,
              sku: Optional[SkuArgs] = None)
@overload
def ApiPortal(resource_name: str,
              args: ApiPortalArgs,
              opts: Optional[ResourceOptions] = 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.

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.

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

The ApiPortal resource accepts the following input properties:

ResourceGroupName string

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.

ApiPortalName string

The name of API portal.

Properties Pulumi.AzureNative.AppPlatform.Inputs.ApiPortalPropertiesArgs

API portal properties payload

Sku Pulumi.AzureNative.AppPlatform.Inputs.SkuArgs

Sku of the API portal resource

ResourceGroupName string

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.

ApiPortalName string

The name of API portal.

Properties ApiPortalPropertiesArgs

API portal properties payload

Sku SkuArgs

Sku of the API portal resource

resourceGroupName String

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.

apiPortalName String

The name of API portal.

properties ApiPortalPropertiesArgs

API portal properties payload

sku SkuArgs

Sku of the API portal resource

resourceGroupName string

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.

apiPortalName string

The name of API portal.

properties ApiPortalPropertiesArgs

API portal properties payload

sku SkuArgs

Sku of the API portal resource

resource_group_name str

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

The name of API portal.

properties ApiPortalPropertiesArgs

API portal properties payload

sku SkuArgs

Sku of the API portal resource

resourceGroupName String

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.

apiPortalName String

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:

Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of the resource.

SystemData Pulumi.AzureNative.AppPlatform.Outputs.SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

Type string

The type of the resource.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of the resource.

SystemData SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

Type string

The type of the resource.

id String

The provider-assigned unique ID for this managed resource.

name String

The name of the resource.

systemData SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

type String

The type of the resource.

id string

The provider-assigned unique ID for this managed resource.

name string

The name of the resource.

systemData SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

type string

The type of the resource.

id str

The provider-assigned unique ID for this managed resource.

name str

The name of the resource.

system_data SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

type str

The type 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

ApiPortalInstanceResponse

Name string

Name of the API portal instance

Status string

Status of the API portal instance

Name string

Name of the API portal instance

Status string

Status of the API portal instance

name String

Name of the API portal instance

status String

Status of the API portal instance

name string

Name of the API portal instance

status string

Status of the API portal instance

name str

Name of the API portal instance

status str

Status of the API portal instance

name String

Name of the API portal instance

status String

Status of the API portal instance

ApiPortalProperties

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.AzureNative.AppPlatform.Inputs.SsoProperties

Single sign-on related configuration

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

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

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

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

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

Instances List<Pulumi.AzureNative.AppPlatform.Inputs.ApiPortalInstanceResponse>

Collection of instances belong to API portal.

ProvisioningState string

State of the API portal.

ResourceRequests Pulumi.AzureNative.AppPlatform.Inputs.ApiPortalResourceRequestsResponse

The requested resource quantity for required CPU and Memory.

Url string

URL of the API portal, exposed when 'public' is true.

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.AzureNative.AppPlatform.Inputs.SsoPropertiesResponse

Single sign-on related configuration

Instances []ApiPortalInstanceResponse

Collection of instances belong to API portal.

ProvisioningState string

State of the API portal.

ResourceRequests ApiPortalResourceRequestsResponse

The requested resource quantity for required CPU and Memory.

Url string

URL of the API portal, exposed when 'public' is true.

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 SsoPropertiesResponse

Single sign-on related configuration

instances List<ApiPortalInstanceResponse>

Collection of instances belong to API portal.

provisioningState String

State of the API portal.

resourceRequests ApiPortalResourceRequestsResponse

The requested resource quantity for required CPU and Memory.

url String

URL of the API portal, exposed when 'public' is true.

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 SsoPropertiesResponse

Single sign-on related configuration

instances ApiPortalInstanceResponse[]

Collection of instances belong to API portal.

provisioningState string

State of the API portal.

resourceRequests ApiPortalResourceRequestsResponse

The requested resource quantity for required CPU and Memory.

url string

URL of the API portal, exposed when 'public' is true.

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 SsoPropertiesResponse

Single sign-on related configuration

instances Sequence[ApiPortalInstanceResponse]

Collection of instances belong to API portal.

provisioning_state str

State of the API portal.

resource_requests ApiPortalResourceRequestsResponse

The requested resource quantity for required CPU and Memory.

url str

URL of the API portal, exposed when 'public' is true.

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 SsoPropertiesResponse

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.

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

Cpu string

Cpu allocated to each API portal instance

Memory string

Memory allocated to each API portal instance

Cpu string

Cpu allocated to each API portal instance

Memory string

Memory allocated to each API portal instance

cpu String

Cpu allocated to each API portal instance

memory String

Memory allocated to each API portal instance

cpu string

Cpu allocated to each API portal instance

memory string

Memory allocated to each API portal instance

cpu str

Cpu allocated to each API portal instance

memory str

Memory allocated to each API portal instance

cpu String

Cpu allocated to each API portal instance

memory String

Memory allocated to each API portal instance

Sku

Capacity int

Current capacity of the target resource

Name string

Name of the Sku

Tier string

Tier of the Sku

Capacity int

Current capacity of the target resource

Name string

Name of the Sku

Tier string

Tier of the Sku

capacity Integer

Current capacity of the target resource

name String

Name of the Sku

tier String

Tier of the Sku

capacity number

Current capacity of the target resource

name string

Name of the Sku

tier string

Tier of the Sku

capacity int

Current capacity of the target resource

name str

Name of the Sku

tier str

Tier of the Sku

capacity Number

Current capacity of the target resource

name String

Name of the Sku

tier String

Tier of the Sku

SkuResponse

Capacity int

Current capacity of the target resource

Name string

Name of the Sku

Tier string

Tier of the Sku

Capacity int

Current capacity of the target resource

Name string

Name of the Sku

Tier string

Tier of the Sku

capacity Integer

Current capacity of the target resource

name String

Name of the Sku

tier String

Tier of the Sku

capacity number

Current capacity of the target resource

name string

Name of the Sku

tier string

Tier of the Sku

capacity int

Current capacity of the target resource

name str

Name of the Sku

tier str

Tier of the Sku

capacity Number

Current capacity of the target resource

name String

Name of the Sku

tier String

Tier of the Sku

SsoProperties

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

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

CreatedAt string

The timestamp of resource creation (UTC).

CreatedBy string

The identity that created the resource.

CreatedByType string

The type of identity that created the resource.

LastModifiedAt string

The timestamp of resource last modification (UTC)

LastModifiedBy string

The identity that last modified the resource.

LastModifiedByType string

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.

CreatedByType string

The type of identity that created the resource.

LastModifiedAt string

The timestamp of resource last modification (UTC)

LastModifiedBy string

The identity that last modified the resource.

LastModifiedByType string

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.

createdByType String

The type of identity that created the resource.

lastModifiedAt String

The timestamp of resource last modification (UTC)

lastModifiedBy String

The identity that last modified the resource.

lastModifiedByType String

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.

createdByType string

The type of identity that created the resource.

lastModifiedAt string

The timestamp of resource last modification (UTC)

lastModifiedBy string

The identity that last modified the resource.

lastModifiedByType string

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

The type of identity that created the resource.

last_modified_at str

The timestamp of resource last modification (UTC)

last_modified_by str

The identity that last modified the resource.

last_modified_by_type str

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.

createdByType String

The type of identity that created the resource.

lastModifiedAt String

The timestamp of resource last modification (UTC)

lastModifiedBy String

The identity that last modified the resource.

lastModifiedByType String

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/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apiPortals/default 

Package Details

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