Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.0 published on Wednesday, May 4, 2022 by Pulumi

getApiPortal

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

Using getApiPortal

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getApiPortal(args: GetApiPortalArgs, opts?: InvokeOptions): Promise<GetApiPortalResult>
function getApiPortalOutput(args: GetApiPortalOutputArgs, opts?: InvokeOptions): Output<GetApiPortalResult>
def get_api_portal(api_portal_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   service_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetApiPortalResult
def get_api_portal_output(api_portal_name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   service_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetApiPortalResult]
func LookupApiPortal(ctx *Context, args *LookupApiPortalArgs, opts ...InvokeOption) (*LookupApiPortalResult, error)
func LookupApiPortalOutput(ctx *Context, args *LookupApiPortalOutputArgs, opts ...InvokeOption) LookupApiPortalResultOutput

> Note: This function is named LookupApiPortal in the Go SDK.

public static class GetApiPortal 
{
    public static Task<GetApiPortalResult> InvokeAsync(GetApiPortalArgs args, InvokeOptions? opts = null)
    public static Output<GetApiPortalResult> Invoke(GetApiPortalInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetApiPortalResult> getApiPortal(GetApiPortalArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:appplatform:getApiPortal
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ApiPortalName string

The name of API portal.

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.

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.

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.

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.

api_portal_name str

The name of API portal.

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.

apiPortalName String

The name of API portal.

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.

getApiPortal Result

The following output properties are available:

Id string

Fully qualified resource Id for the resource.

Name string

The name of the resource.

Properties Pulumi.AzureNative.AppPlatform.Outputs.ApiPortalPropertiesResponse

API portal properties payload

SystemData Pulumi.AzureNative.AppPlatform.Outputs.SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

Type string

The type of the resource.

Sku Pulumi.AzureNative.AppPlatform.Outputs.SkuResponse

Sku of the API portal resource

Id string

Fully qualified resource Id for the resource.

Name string

The name of the resource.

Properties ApiPortalPropertiesResponse

API portal properties payload

SystemData SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

Type string

The type of the resource.

Sku SkuResponse

Sku of the API portal resource

id String

Fully qualified resource Id for the resource.

name String

The name of the resource.

properties ApiPortalPropertiesResponse

API portal properties payload

systemData SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

type String

The type of the resource.

sku SkuResponse

Sku of the API portal resource

id string

Fully qualified resource Id for the resource.

name string

The name of the resource.

properties ApiPortalPropertiesResponse

API portal properties payload

systemData SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

type string

The type of the resource.

sku SkuResponse

Sku of the API portal resource

id str

Fully qualified resource Id for the resource.

name str

The name of the resource.

properties ApiPortalPropertiesResponse

API portal properties payload

system_data SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

type str

The type of the resource.

sku SkuResponse

Sku of the API portal resource

id String

Fully qualified resource Id for the resource.

name String

The name of the resource.

properties Property Map

API portal properties payload

systemData Property Map

Metadata pertaining to creation and last modification of the resource.

type String

The type of the resource.

sku Property Map

Sku of the API portal 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

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 ListPortalInstanceResponse>

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

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

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

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

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

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

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

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

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

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.

Package Details

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