Microsoft.AppPlatform Spring/apiPortals 2022-05-01-preview
Bicep resource definition
The Spring/apiPortals resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AppPlatform/Spring/apiPortals resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AppPlatform/Spring/apiPortals@2022-05-01-preview' = {
name: 'string'
sku: {
capacity: int
name: 'string'
tier: 'string'
}
parent: resourceSymbolicName
properties: {
gatewayIds: [
'string'
]
httpsOnly: bool
public: bool
sourceUrls: [
'string'
]
ssoProperties: {
clientId: 'string'
clientSecret: 'string'
issuerUri: 'string'
scope: [
'string'
]
}
}
}
Property values
Spring/apiPortals
Name | Description | Value |
---|---|---|
name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
sku | Sku of the API portal resource | Sku |
parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: Spring |
properties | API portal properties payload | ApiPortalProperties |
ApiPortalProperties
Name | Description | Value |
---|---|---|
gatewayIds | The array of resource Ids of gateway to integrate with API portal. | string[] |
httpsOnly | Indicate if only https is allowed. | bool |
public | Indicates whether the API portal exposes endpoint. | bool |
sourceUrls | Collection of OpenAPI source URL locations. | string[] |
ssoProperties | Single sign-on related configuration | SsoProperties |
SsoProperties
Name | Description | Value |
---|---|---|
clientId | The public identifier for the application | string |
clientSecret | The secret known only to the application and the authorization server | string |
issuerUri | The URI of Issuer Identifier | string |
scope | It defines the specific actions applications can be allowed to do on a user's behalf | string[] |
Sku
Name | Description | Value |
---|---|---|
capacity | Current capacity of the target resource | int |
name | Name of the Sku | string |
tier | Tier of the Sku | string |
ARM template resource definition
The Spring/apiPortals resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AppPlatform/Spring/apiPortals resource, add the following JSON to your template.
{
"type": "Microsoft.AppPlatform/Spring/apiPortals",
"apiVersion": "2022-05-01-preview",
"name": "string",
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"properties": {
"gatewayIds": [ "string" ],
"httpsOnly": "bool",
"public": "bool",
"sourceUrls": [ "string" ],
"ssoProperties": {
"clientId": "string",
"clientSecret": "string",
"issuerUri": "string",
"scope": [ "string" ]
}
}
}
Property values
Spring/apiPortals
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.AppPlatform/Spring/apiPortals' |
apiVersion | The resource api version | '2022-05-01-preview' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
sku | Sku of the API portal resource | Sku |
properties | API portal properties payload | ApiPortalProperties |
ApiPortalProperties
Name | Description | Value |
---|---|---|
gatewayIds | The array of resource Ids of gateway to integrate with API portal. | string[] |
httpsOnly | Indicate if only https is allowed. | bool |
public | Indicates whether the API portal exposes endpoint. | bool |
sourceUrls | Collection of OpenAPI source URL locations. | string[] |
ssoProperties | Single sign-on related configuration | SsoProperties |
SsoProperties
Name | Description | Value |
---|---|---|
clientId | The public identifier for the application | string |
clientSecret | The secret known only to the application and the authorization server | string |
issuerUri | The URI of Issuer Identifier | string |
scope | It defines the specific actions applications can be allowed to do on a user's behalf | string[] |
Sku
Name | Description | Value |
---|---|---|
capacity | Current capacity of the target resource | int |
name | Name of the Sku | string |
tier | Tier of the Sku | string |
Terraform (AzAPI provider) resource definition
The Spring/apiPortals resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AppPlatform/Spring/apiPortals resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AppPlatform/Spring/apiPortals@2022-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
gatewayIds = [
"string"
]
httpsOnly = bool
public = bool
sourceUrls = [
"string"
]
ssoProperties = {
clientId = "string"
clientSecret = "string"
issuerUri = "string"
scope = [
"string"
]
}
}
sku = {
capacity = int
name = "string"
tier = "string"
}
})
}
Property values
Spring/apiPortals
Name | Description | Value |
---|---|---|
type | The resource type | "Microsoft.AppPlatform/Spring/apiPortals@2022-05-01-preview" |
name | The resource name | string (required) |
parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: Spring |
sku | Sku of the API portal resource | Sku |
properties | API portal properties payload | ApiPortalProperties |
ApiPortalProperties
Name | Description | Value |
---|---|---|
gatewayIds | The array of resource Ids of gateway to integrate with API portal. | string[] |
httpsOnly | Indicate if only https is allowed. | bool |
public | Indicates whether the API portal exposes endpoint. | bool |
sourceUrls | Collection of OpenAPI source URL locations. | string[] |
ssoProperties | Single sign-on related configuration | SsoProperties |
SsoProperties
Name | Description | Value |
---|---|---|
clientId | The public identifier for the application | string |
clientSecret | The secret known only to the application and the authorization server | string |
issuerUri | The URI of Issuer Identifier | string |
scope | It defines the specific actions applications can be allowed to do on a user's behalf | string[] |
Sku
Name | Description | Value |
---|---|---|
capacity | Current capacity of the target resource | int |
name | Name of the Sku | string |
tier | Tier of the Sku | string |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for