The Spring/apiPortals resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.AppPlatform/Spring/apiPortals resource, add the following JSON to your template.
{
"type": "Microsoft.AppPlatform/Spring/apiPortals",
"apiVersion": "2023-03-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" ]
}
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.AppPlatform/Spring/apiPortals' |
apiVersion | The resource api version | '2023-03-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 |
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 |
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[] |
Name | Description | Value |
---|---|---|
capacity | Current capacity of the target resource | int |
name | Name of the Sku | string |
tier | Tier of the Sku | string |