Microsoft.Web (preview:2015-08-01)

2025/09/30 • 9 new, 9 deleted methods

ManagedApis_List (new)
Description :  Gets a list of managed APIs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/managedApis
{
location:
{
Description: The location. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the API the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
generalInformation:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
iconUrl:
{
Description: Icon Url ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
description:
{
Description: Description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: a public accessible url of the Terms Of Use Url of this API ,
Required: False ,
}
string ,
connectionDisplayName:
{
Description: DefaultConnectionNameTemplate ,
Required: False ,
}
string ,
connectionPortalUrl:
{
Description: ConnectionPortalUrl ,
Required: False ,
}
object ,
}
,
}
,
path:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
runtimeUrls:
{
Description: Read only property returning the runtime endpoints where the API can be called ,
Required: False ,
}
[
string ,
]
,
protocols:
{
Description: Protocols supported by the front end - http/https ,
Required: False ,
}
[
string ,
]
,
policies:
{
Description: API policies ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
content:
{
Description: Content of xml policy ,
Required: False ,
}
string ,
}
,
}
,
backendService:
{
Description: Backend service definition ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
serviceUrl:
{
Description: Url from which the swagger payload will be fetched ,
Required: False ,
}
string ,
hostingEnvironmentServiceUrls:
{
Description: Service Urls per Hosting environment ,
Required: False ,
}
[
{
hostingEnvironmentId:
{
Description: Hosting environment Id ,
Required: False ,
}
string ,
hostId:
{
Description: Host Id ,
Required: False ,
}
string ,
serviceUrl:
{
Description: service url to use ,
Required: False ,
}
string ,
useInternalRouting:
{
Description: When the backend url is in same ASE, for performance reason this flag can be set to true If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only via API calls Note: calls will fail if this option is used but back end is not on the same ASE ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
apiDefinitionUrl:
{
Description: API definition Url - url where the swagger can be downloaded from ,
Required: False ,
}
string ,
metadata:
{
Description: Free form object for the data caller wants to store ,
Required: False ,
}
object ,
capabilities:
{
Description: Capabilities ,
Required: False ,
}
[
string ,
]
,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ManagedApis_Get (new)
Description :  Gets a managed API.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/managedApis/{apiName}
{
location:
{
Description: The location. ,
Required: True ,
}
string ,
apiName:
{
Description: The managed API name. ,
Required: True ,
}
string ,
export:
{
Description: flag showing whether to export API definition in format specified by Accept header. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the API the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
generalInformation:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
iconUrl:
{
Description: Icon Url ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
description:
{
Description: Description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: a public accessible url of the Terms Of Use Url of this API ,
Required: False ,
}
string ,
connectionDisplayName:
{
Description: DefaultConnectionNameTemplate ,
Required: False ,
}
string ,
connectionPortalUrl:
{
Description: ConnectionPortalUrl ,
Required: False ,
}
object ,
}
,
}
,
path:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
runtimeUrls:
{
Description: Read only property returning the runtime endpoints where the API can be called ,
Required: False ,
}
[
string ,
]
,
protocols:
{
Description: Protocols supported by the front end - http/https ,
Required: False ,
}
[
string ,
]
,
policies:
{
Description: API policies ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
content:
{
Description: Content of xml policy ,
Required: False ,
}
string ,
}
,
}
,
backendService:
{
Description: Backend service definition ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
serviceUrl:
{
Description: Url from which the swagger payload will be fetched ,
Required: False ,
}
string ,
hostingEnvironmentServiceUrls:
{
Description: Service Urls per Hosting environment ,
Required: False ,
}
[
{
hostingEnvironmentId:
{
Description: Hosting environment Id ,
Required: False ,
}
string ,
hostId:
{
Description: Host Id ,
Required: False ,
}
string ,
serviceUrl:
{
Description: service url to use ,
Required: False ,
}
string ,
useInternalRouting:
{
Description: When the backend url is in same ASE, for performance reason this flag can be set to true If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only via API calls Note: calls will fail if this option is used but back end is not on the same ASE ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
apiDefinitionUrl:
{
Description: API definition Url - url where the swagger can be downloaded from ,
Required: False ,
}
string ,
metadata:
{
Description: Free form object for the data caller wants to store ,
Required: False ,
}
object ,
capabilities:
{
Description: Capabilities ,
Required: False ,
}
[
string ,
]
,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Connections_List (new)
Description :  Gets a list of connections.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections
{
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: connection name ,
Required: False ,
}
string ,
displayName:
{
Description: display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
status:
{
Description: Status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Error details ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
customParameterValues:
{
Description: Custom login setting values. ,
Required: False ,
}
object ,
tenantId:
{
Required: False ,
}
string ,
parameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
metadata:
{
Required: False ,
}
object ,
firstExpirationTime:
{
Description: Time in UTC when the first expiration of OAuth tokens ,
Format: date-time ,
Required: False ,
}
string ,
keywords:
{
Description: List of Keywords that tag the acl ,
Required: False ,
}
[
string ,
]
,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
api:
{
Description: expanded connection provider name ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id of connection provider ,
Required: False ,
}
string ,
entity:
{
Description: Id of connection provider ,
Required: False ,
}
{
id:
{
Description: Resource Id. Typically id is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g Microsoft.Web/sites ,
Required: False ,
}
string ,
location:
{
Description: Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan ,
Required: False ,
}
{
name:
{
Description: The name ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ,
Required: False ,
}
string ,
product:
{
Description: The product ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code ,
Required: False ,
}
string ,
version:
{
Description: Version of product ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the API the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
generalInformation:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
iconUrl:
{
Description: Icon Url ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
description:
{
Description: Description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: a public accessible url of the Terms Of Use Url of this API ,
Required: False ,
}
string ,
connectionDisplayName:
{
Description: DefaultConnectionNameTemplate ,
Required: False ,
}
string ,
connectionPortalUrl:
{
Description: ConnectionPortalUrl ,
Required: False ,
}
object ,
}
,
}
,
path:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
runtimeUrls:
{
Description: Read only property returning the runtime endpoints where the API can be called ,
Required: False ,
}
[
string ,
]
,
protocols:
{
Description: Protocols supported by the front end - http/https ,
Required: False ,
}
[
string ,
]
,
policies:
{
Description: API policies ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
content:
{
Description: Content of xml policy ,
Required: False ,
}
string ,
}
,
}
,
backendService:
{
Description: Backend service definition ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
serviceUrl:
{
Description: Url from which the swagger payload will be fetched ,
Required: False ,
}
string ,
hostingEnvironmentServiceUrls:
{
Description: Service Urls per Hosting environment ,
Required: False ,
}
[
{
hostingEnvironmentId:
{
Description: Hosting environment Id ,
Required: False ,
}
string ,
hostId:
{
Description: Host Id ,
Required: False ,
}
string ,
serviceUrl:
{
Description: service url to use ,
Required: False ,
}
string ,
useInternalRouting:
{
Description: When the backend url is in same ASE, for performance reason this flag can be set to true If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only via API calls Note: calls will fail if this option is used but back end is not on the same ASE ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
apiDefinitionUrl:
{
Description: API definition Url - url where the swagger can be downloaded from ,
Required: False ,
}
string ,
metadata:
{
Description: Free form object for the data caller wants to store ,
Required: False ,
}
object ,
capabilities:
{
Description: Capabilities ,
Required: False ,
}
[
string ,
]
,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: Sku description of the resource ,
Required: False ,
}
{
name:
{
Description: Name of the resource sku ,
Required: False ,
}
string ,
tier:
{
Description: Service Tier of the resource sku ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource sku ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource sku ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Connections_Get (new)
Description :  Gets a connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections/{connectionName}
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
connectionName:
{
Description: The connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: connection name ,
Required: False ,
}
string ,
displayName:
{
Description: display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
status:
{
Description: Status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Error details ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
customParameterValues:
{
Description: Custom login setting values. ,
Required: False ,
}
object ,
tenantId:
{
Required: False ,
}
string ,
parameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
metadata:
{
Required: False ,
}
object ,
firstExpirationTime:
{
Description: Time in UTC when the first expiration of OAuth tokens ,
Format: date-time ,
Required: False ,
}
string ,
keywords:
{
Description: List of Keywords that tag the acl ,
Required: False ,
}
[
string ,
]
,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
api:
{
Description: expanded connection provider name ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id of connection provider ,
Required: False ,
}
string ,
entity:
{
Description: Id of connection provider ,
Required: False ,
}
{
id:
{
Description: Resource Id. Typically id is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g Microsoft.Web/sites ,
Required: False ,
}
string ,
location:
{
Description: Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan ,
Required: False ,
}
{
name:
{
Description: The name ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ,
Required: False ,
}
string ,
product:
{
Description: The product ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code ,
Required: False ,
}
string ,
version:
{
Description: Version of product ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the API the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
generalInformation:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
iconUrl:
{
Description: Icon Url ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
description:
{
Description: Description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: a public accessible url of the Terms Of Use Url of this API ,
Required: False ,
}
string ,
connectionDisplayName:
{
Description: DefaultConnectionNameTemplate ,
Required: False ,
}
string ,
connectionPortalUrl:
{
Description: ConnectionPortalUrl ,
Required: False ,
}
object ,
}
,
}
,
path:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
runtimeUrls:
{
Description: Read only property returning the runtime endpoints where the API can be called ,
Required: False ,
}
[
string ,
]
,
protocols:
{
Description: Protocols supported by the front end - http/https ,
Required: False ,
}
[
string ,
]
,
policies:
{
Description: API policies ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
content:
{
Description: Content of xml policy ,
Required: False ,
}
string ,
}
,
}
,
backendService:
{
Description: Backend service definition ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
serviceUrl:
{
Description: Url from which the swagger payload will be fetched ,
Required: False ,
}
string ,
hostingEnvironmentServiceUrls:
{
Description: Service Urls per Hosting environment ,
Required: False ,
}
[
{
hostingEnvironmentId:
{
Description: Hosting environment Id ,
Required: False ,
}
string ,
hostId:
{
Description: Host Id ,
Required: False ,
}
string ,
serviceUrl:
{
Description: service url to use ,
Required: False ,
}
string ,
useInternalRouting:
{
Description: When the backend url is in same ASE, for performance reason this flag can be set to true If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only via API calls Note: calls will fail if this option is used but back end is not on the same ASE ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
apiDefinitionUrl:
{
Description: API definition Url - url where the swagger can be downloaded from ,
Required: False ,
}
string ,
metadata:
{
Description: Free form object for the data caller wants to store ,
Required: False ,
}
object ,
capabilities:
{
Description: Capabilities ,
Required: False ,
}
[
string ,
]
,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: Sku description of the resource ,
Required: False ,
}
{
name:
{
Description: Name of the resource sku ,
Required: False ,
}
string ,
tier:
{
Description: Service Tier of the resource sku ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource sku ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource sku ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}
,
}
Connections_CreateOrUpdate (new)
Description :  Creates or updates a connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections/{connectionName}
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
connectionName:
{
Description: The connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
connection:
{
Description: The connection. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: connection name ,
Required: False ,
}
string ,
displayName:
{
Description: display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
status:
{
Description: Status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Error details ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
customParameterValues:
{
Description: Custom login setting values. ,
Required: False ,
}
object ,
tenantId:
{
Required: False ,
}
string ,
parameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
metadata:
{
Required: False ,
}
object ,
firstExpirationTime:
{
Description: Time in UTC when the first expiration of OAuth tokens ,
Format: date-time ,
Required: False ,
}
string ,
keywords:
{
Description: List of Keywords that tag the acl ,
Required: False ,
}
[
string ,
]
,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
api:
{
Description: expanded connection provider name ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id of connection provider ,
Required: False ,
}
string ,
entity:
{
Description: Id of connection provider ,
Required: False ,
}
{
id:
{
Description: Resource Id. Typically id is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g Microsoft.Web/sites ,
Required: False ,
}
string ,
location:
{
Description: Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan ,
Required: False ,
}
{
name:
{
Description: The name ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ,
Required: False ,
}
string ,
product:
{
Description: The product ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code ,
Required: False ,
}
string ,
version:
{
Description: Version of product ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the API the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
generalInformation:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
iconUrl:
{
Description: Icon Url ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
description:
{
Description: Description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: a public accessible url of the Terms Of Use Url of this API ,
Required: False ,
}
string ,
connectionDisplayName:
{
Description: DefaultConnectionNameTemplate ,
Required: False ,
}
string ,
connectionPortalUrl:
{
Description: ConnectionPortalUrl ,
Required: False ,
}
object ,
}
,
}
,
path:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
runtimeUrls:
{
Description: Read only property returning the runtime endpoints where the API can be called ,
Required: False ,
}
[
string ,
]
,
protocols:
{
Description: Protocols supported by the front end - http/https ,
Required: False ,
}
[
string ,
]
,
policies:
{
Description: API policies ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
content:
{
Description: Content of xml policy ,
Required: False ,
}
string ,
}
,
}
,
backendService:
{
Description: Backend service definition ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
serviceUrl:
{
Description: Url from which the swagger payload will be fetched ,
Required: False ,
}
string ,
hostingEnvironmentServiceUrls:
{
Description: Service Urls per Hosting environment ,
Required: False ,
}
[
{
hostingEnvironmentId:
{
Description: Hosting environment Id ,
Required: False ,
}
string ,
hostId:
{
Description: Host Id ,
Required: False ,
}
string ,
serviceUrl:
{
Description: service url to use ,
Required: False ,
}
string ,
useInternalRouting:
{
Description: When the backend url is in same ASE, for performance reason this flag can be set to true If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only via API calls Note: calls will fail if this option is used but back end is not on the same ASE ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
apiDefinitionUrl:
{
Description: API definition Url - url where the swagger can be downloaded from ,
Required: False ,
}
string ,
metadata:
{
Description: Free form object for the data caller wants to store ,
Required: False ,
}
object ,
capabilities:
{
Description: Capabilities ,
Required: False ,
}
[
string ,
]
,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: Sku description of the resource ,
Required: False ,
}
{
name:
{
Description: Name of the resource sku ,
Required: False ,
}
string ,
tier:
{
Description: Service Tier of the resource sku ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource sku ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource sku ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: connection name ,
Required: False ,
}
string ,
displayName:
{
Description: display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
status:
{
Description: Status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Error details ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
customParameterValues:
{
Description: Custom login setting values. ,
Required: False ,
}
object ,
tenantId:
{
Required: False ,
}
string ,
parameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
metadata:
{
Required: False ,
}
object ,
firstExpirationTime:
{
Description: Time in UTC when the first expiration of OAuth tokens ,
Format: date-time ,
Required: False ,
}
string ,
keywords:
{
Description: List of Keywords that tag the acl ,
Required: False ,
}
[
string ,
]
,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
api:
{
Description: expanded connection provider name ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id of connection provider ,
Required: False ,
}
string ,
entity:
{
Description: Id of connection provider ,
Required: False ,
}
{
id:
{
Description: Resource Id. Typically id is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g Microsoft.Web/sites ,
Required: False ,
}
string ,
location:
{
Description: Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan ,
Required: False ,
}
{
name:
{
Description: The name ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ,
Required: False ,
}
string ,
product:
{
Description: The product ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code ,
Required: False ,
}
string ,
version:
{
Description: Version of product ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the API the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
generalInformation:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
iconUrl:
{
Description: Icon Url ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
description:
{
Description: Description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: a public accessible url of the Terms Of Use Url of this API ,
Required: False ,
}
string ,
connectionDisplayName:
{
Description: DefaultConnectionNameTemplate ,
Required: False ,
}
string ,
connectionPortalUrl:
{
Description: ConnectionPortalUrl ,
Required: False ,
}
object ,
}
,
}
,
path:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
runtimeUrls:
{
Description: Read only property returning the runtime endpoints where the API can be called ,
Required: False ,
}
[
string ,
]
,
protocols:
{
Description: Protocols supported by the front end - http/https ,
Required: False ,
}
[
string ,
]
,
policies:
{
Description: API policies ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
content:
{
Description: Content of xml policy ,
Required: False ,
}
string ,
}
,
}
,
backendService:
{
Description: Backend service definition ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
serviceUrl:
{
Description: Url from which the swagger payload will be fetched ,
Required: False ,
}
string ,
hostingEnvironmentServiceUrls:
{
Description: Service Urls per Hosting environment ,
Required: False ,
}
[
{
hostingEnvironmentId:
{
Description: Hosting environment Id ,
Required: False ,
}
string ,
hostId:
{
Description: Host Id ,
Required: False ,
}
string ,
serviceUrl:
{
Description: service url to use ,
Required: False ,
}
string ,
useInternalRouting:
{
Description: When the backend url is in same ASE, for performance reason this flag can be set to true If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only via API calls Note: calls will fail if this option is used but back end is not on the same ASE ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
apiDefinitionUrl:
{
Description: API definition Url - url where the swagger can be downloaded from ,
Required: False ,
}
string ,
metadata:
{
Description: Free form object for the data caller wants to store ,
Required: False ,
}
object ,
capabilities:
{
Description: Capabilities ,
Required: False ,
}
[
string ,
]
,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: Sku description of the resource ,
Required: False ,
}
{
name:
{
Description: Name of the resource sku ,
Required: False ,
}
string ,
tier:
{
Description: Service Tier of the resource sku ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource sku ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource sku ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Required: False ,
}
{
name:
{
Description: connection name ,
Required: False ,
}
string ,
displayName:
{
Description: display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
status:
{
Description: Status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Error details ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
customParameterValues:
{
Description: Custom login setting values. ,
Required: False ,
}
object ,
tenantId:
{
Required: False ,
}
string ,
parameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
metadata:
{
Required: False ,
}
object ,
firstExpirationTime:
{
Description: Time in UTC when the first expiration of OAuth tokens ,
Format: date-time ,
Required: False ,
}
string ,
keywords:
{
Description: List of Keywords that tag the acl ,
Required: False ,
}
[
string ,
]
,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
api:
{
Description: expanded connection provider name ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id of connection provider ,
Required: False ,
}
string ,
entity:
{
Description: Id of connection provider ,
Required: False ,
}
{
id:
{
Description: Resource Id. Typically id is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g Microsoft.Web/sites ,
Required: False ,
}
string ,
location:
{
Description: Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan ,
Required: False ,
}
{
name:
{
Description: The name ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ,
Required: False ,
}
string ,
product:
{
Description: The product ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code ,
Required: False ,
}
string ,
version:
{
Description: Version of product ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the API the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
generalInformation:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
iconUrl:
{
Description: Icon Url ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
description:
{
Description: Description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: a public accessible url of the Terms Of Use Url of this API ,
Required: False ,
}
string ,
connectionDisplayName:
{
Description: DefaultConnectionNameTemplate ,
Required: False ,
}
string ,
connectionPortalUrl:
{
Description: ConnectionPortalUrl ,
Required: False ,
}
object ,
}
,
}
,
path:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
runtimeUrls:
{
Description: Read only property returning the runtime endpoints where the API can be called ,
Required: False ,
}
[
string ,
]
,
protocols:
{
Description: Protocols supported by the front end - http/https ,
Required: False ,
}
[
string ,
]
,
policies:
{
Description: API policies ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
content:
{
Description: Content of xml policy ,
Required: False ,
}
string ,
}
,
}
,
backendService:
{
Description: Backend service definition ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
serviceUrl:
{
Description: Url from which the swagger payload will be fetched ,
Required: False ,
}
string ,
hostingEnvironmentServiceUrls:
{
Description: Service Urls per Hosting environment ,
Required: False ,
}
[
{
hostingEnvironmentId:
{
Description: Hosting environment Id ,
Required: False ,
}
string ,
hostId:
{
Description: Host Id ,
Required: False ,
}
string ,
serviceUrl:
{
Description: service url to use ,
Required: False ,
}
string ,
useInternalRouting:
{
Description: When the backend url is in same ASE, for performance reason this flag can be set to true If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only via API calls Note: calls will fail if this option is used but back end is not on the same ASE ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
apiDefinitionUrl:
{
Description: API definition Url - url where the swagger can be downloaded from ,
Required: False ,
}
string ,
metadata:
{
Description: Free form object for the data caller wants to store ,
Required: False ,
}
object ,
capabilities:
{
Description: Capabilities ,
Required: False ,
}
[
string ,
]
,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: Sku description of the resource ,
Required: False ,
}
{
name:
{
Description: Name of the resource sku ,
Required: False ,
}
string ,
tier:
{
Description: Service Tier of the resource sku ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource sku ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource sku ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}
,
}
Connections_Delete (new)
Description :  Deletes a connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections/{connectionName}
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
connectionName:
{
Description: The connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Connections_ConfirmConsentCode (new)
Description :  Confirms consent code of a connection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections/{connectionName}/confirmConsentCode
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
connectionName:
{
Description: The connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
content:
{
Description: The content. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
principalType:
{
Description: Principal type ,
Enum:
{
ActiveDirectory: No description available. ,
Connection: No description available. ,
MicrosoftAccount: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
objectId:
{
Description: AAD object ID. This is userId ,
Required: False ,
}
string ,
code:
{
Description: Code that was returned during consent flow ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: connection name ,
Required: False ,
}
string ,
displayName:
{
Description: display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
status:
{
Description: Status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Error details ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
customParameterValues:
{
Description: Custom login setting values. ,
Required: False ,
}
object ,
tenantId:
{
Required: False ,
}
string ,
parameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
metadata:
{
Required: False ,
}
object ,
firstExpirationTime:
{
Description: Time in UTC when the first expiration of OAuth tokens ,
Format: date-time ,
Required: False ,
}
string ,
keywords:
{
Description: List of Keywords that tag the acl ,
Required: False ,
}
[
string ,
]
,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
api:
{
Description: expanded connection provider name ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id of connection provider ,
Required: False ,
}
string ,
entity:
{
Description: Id of connection provider ,
Required: False ,
}
{
id:
{
Description: Resource Id. Typically id is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g Microsoft.Web/sites ,
Required: False ,
}
string ,
location:
{
Description: Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan ,
Required: False ,
}
{
name:
{
Description: The name ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ,
Required: False ,
}
string ,
product:
{
Description: The product ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code ,
Required: False ,
}
string ,
version:
{
Description: Version of product ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the API the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
generalInformation:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
iconUrl:
{
Description: Icon Url ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
description:
{
Description: Description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: a public accessible url of the Terms Of Use Url of this API ,
Required: False ,
}
string ,
connectionDisplayName:
{
Description: DefaultConnectionNameTemplate ,
Required: False ,
}
string ,
connectionPortalUrl:
{
Description: ConnectionPortalUrl ,
Required: False ,
}
object ,
}
,
}
,
path:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
runtimeUrls:
{
Description: Read only property returning the runtime endpoints where the API can be called ,
Required: False ,
}
[
string ,
]
,
protocols:
{
Description: Protocols supported by the front end - http/https ,
Required: False ,
}
[
string ,
]
,
policies:
{
Description: API policies ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
content:
{
Description: Content of xml policy ,
Required: False ,
}
string ,
}
,
}
,
backendService:
{
Description: Backend service definition ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
serviceUrl:
{
Description: Url from which the swagger payload will be fetched ,
Required: False ,
}
string ,
hostingEnvironmentServiceUrls:
{
Description: Service Urls per Hosting environment ,
Required: False ,
}
[
{
hostingEnvironmentId:
{
Description: Hosting environment Id ,
Required: False ,
}
string ,
hostId:
{
Description: Host Id ,
Required: False ,
}
string ,
serviceUrl:
{
Description: service url to use ,
Required: False ,
}
string ,
useInternalRouting:
{
Description: When the backend url is in same ASE, for performance reason this flag can be set to true If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only via API calls Note: calls will fail if this option is used but back end is not on the same ASE ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
apiDefinitionUrl:
{
Description: API definition Url - url where the swagger can be downloaded from ,
Required: False ,
}
string ,
metadata:
{
Description: Free form object for the data caller wants to store ,
Required: False ,
}
object ,
capabilities:
{
Description: Capabilities ,
Required: False ,
}
[
string ,
]
,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: Sku description of the resource ,
Required: False ,
}
{
name:
{
Description: Name of the resource sku ,
Required: False ,
}
string ,
tier:
{
Description: Service Tier of the resource sku ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource sku ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource sku ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}
,
}
Connections_ListConnectionKeys (new)
Description :  Lists connection keys.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections/{connectionName}/listConnectionKeys
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
connectionName:
{
Description: The connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
content:
{
Description: The content. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
validityTimeSpan:
{
Description: time span for how long the keys will be valid ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
parameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
connectionKey:
{
Description: Connection Key ,
Required: False ,
}
string ,
}
ManagedApis_List (removed)
Description :  Gets a list of managed APIs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/managedApis
{
location:
{
Description: The location. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the API the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
generalInformation:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
iconUrl:
{
Description: Icon Url ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
description:
{
Description: Description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: a public accessible url of the Terms Of Use Url of this API ,
Required: False ,
}
string ,
connectionDisplayName:
{
Description: DefaultConnectionNameTemplate ,
Required: False ,
}
string ,
connectionPortalUrl:
{
Description: ConnectionPortalUrl ,
Required: False ,
}
object ,
}
,
}
,
path:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
runtimeUrls:
{
Description: Read only property returning the runtime endpoints where the API can be called ,
Required: False ,
}
[
string ,
]
,
protocols:
{
Description: Protocols supported by the front end - http/https ,
Required: False ,
}
[
string ,
]
,
policies:
{
Description: API policies ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
content:
{
Description: Content of xml policy ,
Required: False ,
}
string ,
}
,
}
,
backendService:
{
Description: Backend service definition ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
serviceUrl:
{
Description: Url from which the swagger payload will be fetched ,
Required: False ,
}
string ,
hostingEnvironmentServiceUrls:
{
Description: Service Urls per Hosting environment ,
Required: False ,
}
[
{
hostingEnvironmentId:
{
Description: Hosting environment Id ,
Required: False ,
}
string ,
hostId:
{
Description: Host Id ,
Required: False ,
}
string ,
serviceUrl:
{
Description: service url to use ,
Required: False ,
}
string ,
useInternalRouting:
{
Description: When the backend url is in same ASE, for performance reason this flag can be set to true If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only via API calls Note: calls will fail if this option is used but back end is not on the same ASE ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
apiDefinitionUrl:
{
Description: API definition Url - url where the swagger can be downloaded from ,
Required: False ,
}
string ,
metadata:
{
Description: Free form object for the data caller wants to store ,
Required: False ,
}
object ,
capabilities:
{
Description: Capabilities ,
Required: False ,
}
[
string ,
]
,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
ManagedApis_Get (removed)
Description :  Gets a managed API.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/managedApis/{apiName}
{
location:
{
Description: The location. ,
Required: True ,
}
string ,
apiName:
{
Description: The managed API name. ,
Required: True ,
}
string ,
export:
{
Description: flag showing whether to export API definition in format specified by Accept header. ,
Required: False ,
}
boolean ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the API the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
generalInformation:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
iconUrl:
{
Description: Icon Url ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
description:
{
Description: Description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: a public accessible url of the Terms Of Use Url of this API ,
Required: False ,
}
string ,
connectionDisplayName:
{
Description: DefaultConnectionNameTemplate ,
Required: False ,
}
string ,
connectionPortalUrl:
{
Description: ConnectionPortalUrl ,
Required: False ,
}
object ,
}
,
}
,
path:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
runtimeUrls:
{
Description: Read only property returning the runtime endpoints where the API can be called ,
Required: False ,
}
[
string ,
]
,
protocols:
{
Description: Protocols supported by the front end - http/https ,
Required: False ,
}
[
string ,
]
,
policies:
{
Description: API policies ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
content:
{
Description: Content of xml policy ,
Required: False ,
}
string ,
}
,
}
,
backendService:
{
Description: Backend service definition ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
serviceUrl:
{
Description: Url from which the swagger payload will be fetched ,
Required: False ,
}
string ,
hostingEnvironmentServiceUrls:
{
Description: Service Urls per Hosting environment ,
Required: False ,
}
[
{
hostingEnvironmentId:
{
Description: Hosting environment Id ,
Required: False ,
}
string ,
hostId:
{
Description: Host Id ,
Required: False ,
}
string ,
serviceUrl:
{
Description: service url to use ,
Required: False ,
}
string ,
useInternalRouting:
{
Description: When the backend url is in same ASE, for performance reason this flag can be set to true If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only via API calls Note: calls will fail if this option is used but back end is not on the same ASE ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
apiDefinitionUrl:
{
Description: API definition Url - url where the swagger can be downloaded from ,
Required: False ,
}
string ,
metadata:
{
Description: Free form object for the data caller wants to store ,
Required: False ,
}
object ,
capabilities:
{
Description: Capabilities ,
Required: False ,
}
[
string ,
]
,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
Connections_List (removed)
Description :  Gets a list of connections.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections
{
resourceGroupName:
{
Description: Resource Group Name ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of resources ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
name:
{
Description: connection name ,
Required: False ,
}
string ,
displayName:
{
Description: display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
status:
{
Description: Status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Error details ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
customParameterValues:
{
Description: Custom login setting values. ,
Required: False ,
}
object ,
tenantId:
{
Required: False ,
}
string ,
parameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
metadata:
{
Required: False ,
}
object ,
firstExpirationTime:
{
Description: Time in UTC when the first expiration of OAuth tokens ,
Format: date-time ,
Required: False ,
}
string ,
keywords:
{
Description: List of Keywords that tag the acl ,
Required: False ,
}
[
string ,
]
,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
api:
{
Description: expanded connection provider name ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id of connection provider ,
Required: False ,
}
string ,
entity:
{
Description: Id of connection provider ,
Required: False ,
}
{
id:
{
Description: Resource Id. Typically id is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g Microsoft.Web/sites ,
Required: False ,
}
string ,
location:
{
Description: Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan ,
Required: False ,
}
{
name:
{
Description: The name ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ,
Required: False ,
}
string ,
product:
{
Description: The product ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code ,
Required: False ,
}
string ,
version:
{
Description: Version of product ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the API the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
generalInformation:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
iconUrl:
{
Description: Icon Url ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
description:
{
Description: Description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: a public accessible url of the Terms Of Use Url of this API ,
Required: False ,
}
string ,
connectionDisplayName:
{
Description: DefaultConnectionNameTemplate ,
Required: False ,
}
string ,
connectionPortalUrl:
{
Description: ConnectionPortalUrl ,
Required: False ,
}
object ,
}
,
}
,
path:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
runtimeUrls:
{
Description: Read only property returning the runtime endpoints where the API can be called ,
Required: False ,
}
[
string ,
]
,
protocols:
{
Description: Protocols supported by the front end - http/https ,
Required: False ,
}
[
string ,
]
,
policies:
{
Description: API policies ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
content:
{
Description: Content of xml policy ,
Required: False ,
}
string ,
}
,
}
,
backendService:
{
Description: Backend service definition ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
serviceUrl:
{
Description: Url from which the swagger payload will be fetched ,
Required: False ,
}
string ,
hostingEnvironmentServiceUrls:
{
Description: Service Urls per Hosting environment ,
Required: False ,
}
[
{
hostingEnvironmentId:
{
Description: Hosting environment Id ,
Required: False ,
}
string ,
hostId:
{
Description: Host Id ,
Required: False ,
}
string ,
serviceUrl:
{
Description: service url to use ,
Required: False ,
}
string ,
useInternalRouting:
{
Description: When the backend url is in same ASE, for performance reason this flag can be set to true If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only via API calls Note: calls will fail if this option is used but back end is not on the same ASE ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
apiDefinitionUrl:
{
Description: API definition Url - url where the swagger can be downloaded from ,
Required: False ,
}
string ,
metadata:
{
Description: Free form object for the data caller wants to store ,
Required: False ,
}
object ,
capabilities:
{
Description: Capabilities ,
Required: False ,
}
[
string ,
]
,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: Sku description of the resource ,
Required: False ,
}
{
name:
{
Description: Name of the resource sku ,
Required: False ,
}
string ,
tier:
{
Description: Service Tier of the resource sku ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource sku ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource sku ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to next page of resources ,
Required: False ,
}
string ,
}
Connections_Get (removed)
Description :  Gets a connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections/{connectionName}
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
connectionName:
{
Description: The connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: connection name ,
Required: False ,
}
string ,
displayName:
{
Description: display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
status:
{
Description: Status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Error details ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
customParameterValues:
{
Description: Custom login setting values. ,
Required: False ,
}
object ,
tenantId:
{
Required: False ,
}
string ,
parameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
metadata:
{
Required: False ,
}
object ,
firstExpirationTime:
{
Description: Time in UTC when the first expiration of OAuth tokens ,
Format: date-time ,
Required: False ,
}
string ,
keywords:
{
Description: List of Keywords that tag the acl ,
Required: False ,
}
[
string ,
]
,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
api:
{
Description: expanded connection provider name ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id of connection provider ,
Required: False ,
}
string ,
entity:
{
Description: Id of connection provider ,
Required: False ,
}
{
id:
{
Description: Resource Id. Typically id is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g Microsoft.Web/sites ,
Required: False ,
}
string ,
location:
{
Description: Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan ,
Required: False ,
}
{
name:
{
Description: The name ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ,
Required: False ,
}
string ,
product:
{
Description: The product ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code ,
Required: False ,
}
string ,
version:
{
Description: Version of product ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the API the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
generalInformation:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
iconUrl:
{
Description: Icon Url ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
description:
{
Description: Description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: a public accessible url of the Terms Of Use Url of this API ,
Required: False ,
}
string ,
connectionDisplayName:
{
Description: DefaultConnectionNameTemplate ,
Required: False ,
}
string ,
connectionPortalUrl:
{
Description: ConnectionPortalUrl ,
Required: False ,
}
object ,
}
,
}
,
path:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
runtimeUrls:
{
Description: Read only property returning the runtime endpoints where the API can be called ,
Required: False ,
}
[
string ,
]
,
protocols:
{
Description: Protocols supported by the front end - http/https ,
Required: False ,
}
[
string ,
]
,
policies:
{
Description: API policies ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
content:
{
Description: Content of xml policy ,
Required: False ,
}
string ,
}
,
}
,
backendService:
{
Description: Backend service definition ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
serviceUrl:
{
Description: Url from which the swagger payload will be fetched ,
Required: False ,
}
string ,
hostingEnvironmentServiceUrls:
{
Description: Service Urls per Hosting environment ,
Required: False ,
}
[
{
hostingEnvironmentId:
{
Description: Hosting environment Id ,
Required: False ,
}
string ,
hostId:
{
Description: Host Id ,
Required: False ,
}
string ,
serviceUrl:
{
Description: service url to use ,
Required: False ,
}
string ,
useInternalRouting:
{
Description: When the backend url is in same ASE, for performance reason this flag can be set to true If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only via API calls Note: calls will fail if this option is used but back end is not on the same ASE ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
apiDefinitionUrl:
{
Description: API definition Url - url where the swagger can be downloaded from ,
Required: False ,
}
string ,
metadata:
{
Description: Free form object for the data caller wants to store ,
Required: False ,
}
object ,
capabilities:
{
Description: Capabilities ,
Required: False ,
}
[
string ,
]
,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: Sku description of the resource ,
Required: False ,
}
{
name:
{
Description: Name of the resource sku ,
Required: False ,
}
string ,
tier:
{
Description: Service Tier of the resource sku ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource sku ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource sku ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}
,
}
Connections_CreateOrUpdate (removed)
Description :  Creates or updates a connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections/{connectionName}
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
connectionName:
{
Description: The connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
connection:
{
Description: The connection. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: connection name ,
Required: False ,
}
string ,
displayName:
{
Description: display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
status:
{
Description: Status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Error details ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
customParameterValues:
{
Description: Custom login setting values. ,
Required: False ,
}
object ,
tenantId:
{
Required: False ,
}
string ,
parameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
metadata:
{
Required: False ,
}
object ,
firstExpirationTime:
{
Description: Time in UTC when the first expiration of OAuth tokens ,
Format: date-time ,
Required: False ,
}
string ,
keywords:
{
Description: List of Keywords that tag the acl ,
Required: False ,
}
[
string ,
]
,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
api:
{
Description: expanded connection provider name ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id of connection provider ,
Required: False ,
}
string ,
entity:
{
Description: Id of connection provider ,
Required: False ,
}
{
id:
{
Description: Resource Id. Typically id is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g Microsoft.Web/sites ,
Required: False ,
}
string ,
location:
{
Description: Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan ,
Required: False ,
}
{
name:
{
Description: The name ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ,
Required: False ,
}
string ,
product:
{
Description: The product ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code ,
Required: False ,
}
string ,
version:
{
Description: Version of product ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the API the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
generalInformation:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
iconUrl:
{
Description: Icon Url ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
description:
{
Description: Description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: a public accessible url of the Terms Of Use Url of this API ,
Required: False ,
}
string ,
connectionDisplayName:
{
Description: DefaultConnectionNameTemplate ,
Required: False ,
}
string ,
connectionPortalUrl:
{
Description: ConnectionPortalUrl ,
Required: False ,
}
object ,
}
,
}
,
path:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
runtimeUrls:
{
Description: Read only property returning the runtime endpoints where the API can be called ,
Required: False ,
}
[
string ,
]
,
protocols:
{
Description: Protocols supported by the front end - http/https ,
Required: False ,
}
[
string ,
]
,
policies:
{
Description: API policies ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
content:
{
Description: Content of xml policy ,
Required: False ,
}
string ,
}
,
}
,
backendService:
{
Description: Backend service definition ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
serviceUrl:
{
Description: Url from which the swagger payload will be fetched ,
Required: False ,
}
string ,
hostingEnvironmentServiceUrls:
{
Description: Service Urls per Hosting environment ,
Required: False ,
}
[
{
hostingEnvironmentId:
{
Description: Hosting environment Id ,
Required: False ,
}
string ,
hostId:
{
Description: Host Id ,
Required: False ,
}
string ,
serviceUrl:
{
Description: service url to use ,
Required: False ,
}
string ,
useInternalRouting:
{
Description: When the backend url is in same ASE, for performance reason this flag can be set to true If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only via API calls Note: calls will fail if this option is used but back end is not on the same ASE ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
apiDefinitionUrl:
{
Description: API definition Url - url where the swagger can be downloaded from ,
Required: False ,
}
string ,
metadata:
{
Description: Free form object for the data caller wants to store ,
Required: False ,
}
object ,
capabilities:
{
Description: Capabilities ,
Required: False ,
}
[
string ,
]
,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: Sku description of the resource ,
Required: False ,
}
{
name:
{
Description: Name of the resource sku ,
Required: False ,
}
string ,
tier:
{
Description: Service Tier of the resource sku ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource sku ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource sku ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: connection name ,
Required: False ,
}
string ,
displayName:
{
Description: display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
status:
{
Description: Status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Error details ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
customParameterValues:
{
Description: Custom login setting values. ,
Required: False ,
}
object ,
tenantId:
{
Required: False ,
}
string ,
parameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
metadata:
{
Required: False ,
}
object ,
firstExpirationTime:
{
Description: Time in UTC when the first expiration of OAuth tokens ,
Format: date-time ,
Required: False ,
}
string ,
keywords:
{
Description: List of Keywords that tag the acl ,
Required: False ,
}
[
string ,
]
,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
api:
{
Description: expanded connection provider name ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id of connection provider ,
Required: False ,
}
string ,
entity:
{
Description: Id of connection provider ,
Required: False ,
}
{
id:
{
Description: Resource Id. Typically id is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g Microsoft.Web/sites ,
Required: False ,
}
string ,
location:
{
Description: Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan ,
Required: False ,
}
{
name:
{
Description: The name ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ,
Required: False ,
}
string ,
product:
{
Description: The product ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code ,
Required: False ,
}
string ,
version:
{
Description: Version of product ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the API the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
generalInformation:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
iconUrl:
{
Description: Icon Url ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
description:
{
Description: Description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: a public accessible url of the Terms Of Use Url of this API ,
Required: False ,
}
string ,
connectionDisplayName:
{
Description: DefaultConnectionNameTemplate ,
Required: False ,
}
string ,
connectionPortalUrl:
{
Description: ConnectionPortalUrl ,
Required: False ,
}
object ,
}
,
}
,
path:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
runtimeUrls:
{
Description: Read only property returning the runtime endpoints where the API can be called ,
Required: False ,
}
[
string ,
]
,
protocols:
{
Description: Protocols supported by the front end - http/https ,
Required: False ,
}
[
string ,
]
,
policies:
{
Description: API policies ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
content:
{
Description: Content of xml policy ,
Required: False ,
}
string ,
}
,
}
,
backendService:
{
Description: Backend service definition ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
serviceUrl:
{
Description: Url from which the swagger payload will be fetched ,
Required: False ,
}
string ,
hostingEnvironmentServiceUrls:
{
Description: Service Urls per Hosting environment ,
Required: False ,
}
[
{
hostingEnvironmentId:
{
Description: Hosting environment Id ,
Required: False ,
}
string ,
hostId:
{
Description: Host Id ,
Required: False ,
}
string ,
serviceUrl:
{
Description: service url to use ,
Required: False ,
}
string ,
useInternalRouting:
{
Description: When the backend url is in same ASE, for performance reason this flag can be set to true If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only via API calls Note: calls will fail if this option is used but back end is not on the same ASE ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
apiDefinitionUrl:
{
Description: API definition Url - url where the swagger can be downloaded from ,
Required: False ,
}
string ,
metadata:
{
Description: Free form object for the data caller wants to store ,
Required: False ,
}
object ,
capabilities:
{
Description: Capabilities ,
Required: False ,
}
[
string ,
]
,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: Sku description of the resource ,
Required: False ,
}
{
name:
{
Description: Name of the resource sku ,
Required: False ,
}
string ,
tier:
{
Description: Service Tier of the resource sku ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource sku ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource sku ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Required: False ,
}
{
name:
{
Description: connection name ,
Required: False ,
}
string ,
displayName:
{
Description: display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
status:
{
Description: Status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Error details ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
customParameterValues:
{
Description: Custom login setting values. ,
Required: False ,
}
object ,
tenantId:
{
Required: False ,
}
string ,
parameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
metadata:
{
Required: False ,
}
object ,
firstExpirationTime:
{
Description: Time in UTC when the first expiration of OAuth tokens ,
Format: date-time ,
Required: False ,
}
string ,
keywords:
{
Description: List of Keywords that tag the acl ,
Required: False ,
}
[
string ,
]
,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
api:
{
Description: expanded connection provider name ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id of connection provider ,
Required: False ,
}
string ,
entity:
{
Description: Id of connection provider ,
Required: False ,
}
{
id:
{
Description: Resource Id. Typically id is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g Microsoft.Web/sites ,
Required: False ,
}
string ,
location:
{
Description: Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan ,
Required: False ,
}
{
name:
{
Description: The name ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ,
Required: False ,
}
string ,
product:
{
Description: The product ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code ,
Required: False ,
}
string ,
version:
{
Description: Version of product ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the API the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
generalInformation:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
iconUrl:
{
Description: Icon Url ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
description:
{
Description: Description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: a public accessible url of the Terms Of Use Url of this API ,
Required: False ,
}
string ,
connectionDisplayName:
{
Description: DefaultConnectionNameTemplate ,
Required: False ,
}
string ,
connectionPortalUrl:
{
Description: ConnectionPortalUrl ,
Required: False ,
}
object ,
}
,
}
,
path:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
runtimeUrls:
{
Description: Read only property returning the runtime endpoints where the API can be called ,
Required: False ,
}
[
string ,
]
,
protocols:
{
Description: Protocols supported by the front end - http/https ,
Required: False ,
}
[
string ,
]
,
policies:
{
Description: API policies ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
content:
{
Description: Content of xml policy ,
Required: False ,
}
string ,
}
,
}
,
backendService:
{
Description: Backend service definition ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
serviceUrl:
{
Description: Url from which the swagger payload will be fetched ,
Required: False ,
}
string ,
hostingEnvironmentServiceUrls:
{
Description: Service Urls per Hosting environment ,
Required: False ,
}
[
{
hostingEnvironmentId:
{
Description: Hosting environment Id ,
Required: False ,
}
string ,
hostId:
{
Description: Host Id ,
Required: False ,
}
string ,
serviceUrl:
{
Description: service url to use ,
Required: False ,
}
string ,
useInternalRouting:
{
Description: When the backend url is in same ASE, for performance reason this flag can be set to true If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only via API calls Note: calls will fail if this option is used but back end is not on the same ASE ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
apiDefinitionUrl:
{
Description: API definition Url - url where the swagger can be downloaded from ,
Required: False ,
}
string ,
metadata:
{
Description: Free form object for the data caller wants to store ,
Required: False ,
}
object ,
capabilities:
{
Description: Capabilities ,
Required: False ,
}
[
string ,
]
,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: Sku description of the resource ,
Required: False ,
}
{
name:
{
Description: Name of the resource sku ,
Required: False ,
}
string ,
tier:
{
Description: Service Tier of the resource sku ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource sku ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource sku ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}
,
}
Connections_Delete (removed)
Description :  Deletes a connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections/{connectionName}
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
connectionName:
{
Description: The connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
Connections_ConfirmConsentCode (removed)
Description :  Confirms consent code of a connection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections/{connectionName}/confirmConsentCode
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
connectionName:
{
Description: The connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
content:
{
Description: The content. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
principalType:
{
Description: Principal type ,
Enum:
{
ActiveDirectory: No description available. ,
Connection: No description available. ,
MicrosoftAccount: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
objectId:
{
Description: AAD object ID. This is userId ,
Required: False ,
}
string ,
code:
{
Description: Code that was returned during consent flow ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
name:
{
Description: connection name ,
Required: False ,
}
string ,
displayName:
{
Description: display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
status:
{
Description: Status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Error details ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
customParameterValues:
{
Description: Custom login setting values. ,
Required: False ,
}
object ,
tenantId:
{
Required: False ,
}
string ,
parameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
metadata:
{
Required: False ,
}
object ,
firstExpirationTime:
{
Description: Time in UTC when the first expiration of OAuth tokens ,
Format: date-time ,
Required: False ,
}
string ,
keywords:
{
Description: List of Keywords that tag the acl ,
Required: False ,
}
[
string ,
]
,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
api:
{
Description: expanded connection provider name ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
id:
{
Description: Id of connection provider ,
Required: False ,
}
string ,
entity:
{
Description: Id of connection provider ,
Required: False ,
}
{
id:
{
Description: Resource Id. Typically id is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} ,
Required: False ,
}
string ,
name:
{
Description: Name of resource ,
Required: False ,
}
string ,
type:
{
Description: Type of resource e.g Microsoft.Web/sites ,
Required: False ,
}
string ,
location:
{
Description: Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with resource ,
Required: False ,
}
object ,
plan:
{
Description: Azure resource manager plan ,
Required: False ,
}
{
name:
{
Description: The name ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ,
Required: False ,
}
string ,
product:
{
Description: The product ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code ,
Required: False ,
}
string ,
version:
{
Description: Version of product ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource specific properties ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
name:
{
Description: Name of the API the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
generalInformation:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
iconUrl:
{
Description: Icon Url ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
description:
{
Description: Description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: a public accessible url of the Terms Of Use Url of this API ,
Required: False ,
}
string ,
connectionDisplayName:
{
Description: DefaultConnectionNameTemplate ,
Required: False ,
}
string ,
connectionPortalUrl:
{
Description: ConnectionPortalUrl ,
Required: False ,
}
object ,
}
,
}
,
path:
{
Description: the URL path of this API when exposed via APIM ,
Required: False ,
}
string ,
runtimeUrls:
{
Description: Read only property returning the runtime endpoints where the API can be called ,
Required: False ,
}
[
string ,
]
,
protocols:
{
Description: Protocols supported by the front end - http/https ,
Required: False ,
}
[
string ,
]
,
policies:
{
Description: API policies ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
content:
{
Description: Content of xml policy ,
Required: False ,
}
string ,
}
,
}
,
backendService:
{
Description: Backend service definition ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
serviceUrl:
{
Description: Url from which the swagger payload will be fetched ,
Required: False ,
}
string ,
hostingEnvironmentServiceUrls:
{
Description: Service Urls per Hosting environment ,
Required: False ,
}
[
{
hostingEnvironmentId:
{
Description: Hosting environment Id ,
Required: False ,
}
string ,
hostId:
{
Description: Host Id ,
Required: False ,
}
string ,
serviceUrl:
{
Description: service url to use ,
Required: False ,
}
string ,
useInternalRouting:
{
Description: When the backend url is in same ASE, for performance reason this flag can be set to true If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only via API calls Note: calls will fail if this option is used but back end is not on the same ASE ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
apiDefinitionUrl:
{
Description: API definition Url - url where the swagger can be downloaded from ,
Required: False ,
}
string ,
metadata:
{
Description: Free form object for the data caller wants to store ,
Required: False ,
}
object ,
capabilities:
{
Description: Capabilities ,
Required: False ,
}
[
string ,
]
,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
createdTime:
{
Description: Timestamp of the connection creation ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Timestamp of last connection change. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
sku:
{
Description: Sku description of the resource ,
Required: False ,
}
{
name:
{
Description: Name of the resource sku ,
Required: False ,
}
string ,
tier:
{
Description: Service Tier of the resource sku ,
Required: False ,
}
string ,
size:
{
Description: Size specifier of the resource sku ,
Required: False ,
}
string ,
family:
{
Description: Family code of the resource sku ,
Required: False ,
}
string ,
capacity:
{
Description: Current number of instances assigned to the resource ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
}
,
}
Connections_ListConnectionKeys (removed)
Description :  Lists connection keys.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections/{connectionName}/listConnectionKeys
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
connectionName:
{
Description: The connection name. ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
content:
{
Description: The content. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
validityTimeSpan:
{
Description: time span for how long the keys will be valid ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
parameterValues:
{
Description: Tokens/Claim ,
Required: False ,
}
object ,
connectionKey:
{
Description: Connection Key ,
Required: False ,
}
string ,
}