azure-native.appplatform.getApiPortal
Explore with Pulumi AI
Get the API portal and its properties. 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:
- Api
Portal stringName The name of API portal.
- Resource
Group 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.
- Service
Name string The name of the Service resource.
- Api
Portal stringName The name of API portal.
- Resource
Group 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.
- Service
Name string The name of the Service resource.
- api
Portal StringName The name of API portal.
- resource
Group 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.
- service
Name String The name of the Service resource.
- api
Portal stringName The name of API portal.
- resource
Group 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.
- service
Name string The name of the Service resource.
- api_
portal_ strname The name of API portal.
- 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 StringName The name of API portal.
- resource
Group 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.
- service
Name 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.
Azure Native. App Platform. Outputs. Api Portal Properties Response API portal properties payload
- System
Data 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.
- Sku
Pulumi.
Azure Native. App Platform. Outputs. Sku Response Sku of the API portal resource
- Id string
Fully qualified resource Id for the resource.
- Name string
The name of the resource.
- Properties
Api
Portal Properties Response API portal properties payload
- System
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- Type string
The type of the resource.
- Sku
Sku
Response Sku of the API portal resource
- id String
Fully qualified resource Id for the resource.
- name String
The name of the resource.
- properties
Api
Portal Properties Response API portal properties payload
- system
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type String
The type of the resource.
- sku
Sku
Response Sku of the API portal resource
- id string
Fully qualified resource Id for the resource.
- name string
The name of the resource.
- properties
Api
Portal Properties Response API portal properties payload
- system
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type string
The type of the resource.
- sku
Sku
Response Sku of the API portal resource
- id str
Fully qualified resource Id for the resource.
- name str
The name of the resource.
- properties
Api
Portal Properties Response API portal properties payload
- system_
data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type str
The type of the resource.
- sku
Sku
Response 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
- system
Data 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
ApiPortalPropertiesResponse
- Instances
List<Pulumi.
Azure Native. App Platform. Inputs. Api Portal Instance Response> Collection of instances belong to API portal.
- Provisioning
State string State of the API portal.
- Resource
Requests 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.
- Gateway
Ids List<string> 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 List<string> Collection of OpenAPI source URL locations.
- Sso
Properties Pulumi.Azure Native. App Platform. Inputs. Sso Properties Response Single sign-on related configuration
- Instances
[]Api
Portal Instance Response Collection of instances belong to API portal.
- Provisioning
State string State of the API portal.
- Resource
Requests 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.
- Gateway
Ids []string 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 []string Collection of OpenAPI source URL locations.
- Sso
Properties SsoProperties Response Single sign-on related configuration
- instances
List<Api
Portal Instance Response> Collection of instances belong to API portal.
- provisioning
State String State of the API portal.
- resource
Requests 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.
- gateway
Ids List<String> The array of resource Ids of gateway to integrate with API portal.
- https
Only Boolean Indicate if only https is allowed.
- public_ Boolean
Indicates whether the API portal exposes endpoint.
- source
Urls List<String> Collection of OpenAPI source URL locations.
- sso
Properties SsoProperties Response Single sign-on related configuration
- instances
Api
Portal Instance Response[] Collection of instances belong to API portal.
- provisioning
State string State of the API portal.
- resource
Requests 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.
- gateway
Ids string[] The array of resource Ids of gateway to integrate with API portal.
- https
Only boolean Indicate if only https is allowed.
- public boolean
Indicates whether the API portal exposes endpoint.
- source
Urls string[] Collection of OpenAPI source URL locations.
- sso
Properties SsoProperties Response Single sign-on related configuration
- instances
Sequence[Api
Portal 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.
- 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.
- provisioning
State String State of the API portal.
- resource
Requests Property Map The requested resource quantity for required CPU and Memory.
- url String
URL of the API portal, exposed when 'public' is true.
- gateway
Ids List<String> The array of resource Ids of gateway to integrate with API portal.
- https
Only Boolean Indicate if only https is allowed.
- public Boolean
Indicates whether the API portal exposes endpoint.
- source
Urls List<String> Collection of OpenAPI source URL locations.
- sso
Properties Property Map Single sign-on related configuration
ApiPortalResourceRequestsResponse
SkuResponse
SsoPropertiesResponse
- Client
Id string The public identifier for the application
- Client
Secret string The secret known only to the application and the authorization server
- Issuer
Uri 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
- Client
Id string The public identifier for the application
- Client
Secret string The secret known only to the application and the authorization server
- Issuer
Uri 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 String The public identifier for the application
- client
Secret String The secret known only to the application and the authorization server
- issuer
Uri 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
- client
Id string The public identifier for the application
- client
Secret string The secret known only to the application and the authorization server
- issuer
Uri 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
- client
Id String The public identifier for the application
- client
Secret String The secret known only to the application and the authorization server
- issuer
Uri 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
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
- created
At string The timestamp of resource creation (UTC).
- created
By string The identity that created the resource.
- created
By stringType The type of identity that created the resource.
- last
Modified stringAt The timestamp of resource last modification (UTC)
- last
Modified stringBy The identity that last modified the resource.
- last
Modified 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 last 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.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0