Microsoft.Web (stable:2016-06-01)

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

ConnectionGateways_List (new)
Description :  Gets a list of gateways under a subscription
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of connection gateways ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
connectionGatewayInstallation:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
ConnectionGateways_ListByResourceGroup (new)
Description :  Gets a list of gateways under a subscription and in a specific resource group
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of connection gateways ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
connectionGatewayInstallation:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
ConnectionGateways_Get (new)
Description :  Gets a specific gateway under a subscription and in a specific resource group
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
connectionGatewayInstallation:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}
ConnectionGateways_CreateOrUpdate (new)
Description :  Creates or updates a specific gateway for under a subscription and in a specific resource group
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connectionGateways/{connectionGatewayName}
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group ,
Required: True ,
}
string ,
connectionGatewayName:
{
Description: The connection gateway name ,
Required: True ,
}
string ,
connectionGateway:
{
Description: The connection gateway ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
connectionGatewayInstallation:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
connectionGatewayInstallation:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Required: False ,
}
{
connectionGatewayInstallation:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}
ConnectionGateways_Update (new)
Description :  Updates a connection gateway's tags
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connectionGateways/{connectionGatewayName}
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group ,
Required: True ,
}
string ,
connectionGatewayName:
{
Description: The connection gateway name ,
Required: True ,
}
string ,
connectionGateway:
{
Description: The connection gateway ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
connectionGatewayInstallation:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
connectionGatewayInstallation:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}
ConnectionGateways_Delete (new)
Description :  Deletes a specific gateway for under a subscription and in a specific resource group
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}
ConnectionGatewayInstallations_List (new)
Description :  Gets a list of installed gateways that the user is an admin of, in a specific subscription and at a certain location
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of connection gateway installations ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
connectionGateway:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
ConnectionGatewayInstallations_Get (new)
Description :  Get a specific installed gateway that the user is an admin of, in a specific subscription and at a certain location
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
connectionGateway:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}
CustomApis_List (new)
Description :  Gets a list of all custom APIs for a subscription id
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/customApis
{
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 ,
skiptoken:
{
Description: Skip Token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of custom APIs ,
Required: False ,
}
[
{
properties:
{
Description: Custom API properties ,
Required: False ,
}
{
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
runtimeUrls:
{
Description: Runtime URLs ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: The custom API capabilities ,
Required: False ,
}
[
string ,
]
,
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
backendService:
{
Description: The API backend service ,
Required: False ,
}
{
serviceUrl:
{
Description: The service URL ,
Required: False ,
}
string ,
}
,
apiDefinitions:
{
Description: API Definitions ,
Required: False ,
}
{
originalSwaggerUrl:
{
Description: The original swagger URL ,
Required: False ,
}
string ,
modifiedSwaggerUrl:
{
Description: The modified swagger URL ,
Required: False ,
}
string ,
}
,
apiType:
{
Description: The API type ,
Enum:
{
NotSpecified: No description available. ,
Rest: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
wsdlDefinition:
{
Description: The WSDL definition ,
Required: False ,
}
{
url:
{
Description: The WSDL URL ,
Required: False ,
}
string ,
content:
{
Description: The WSDL content ,
Required: False ,
}
string ,
service:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
importMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
}
CustomApis_ListByResourceGroup (new)
Description :  Gets a list of all custom APIs in a subscription for a specific resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/customApis
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group ,
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 ,
skiptoken:
{
Description: Skip Token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of custom APIs ,
Required: False ,
}
[
{
properties:
{
Description: Custom API properties ,
Required: False ,
}
{
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
runtimeUrls:
{
Description: Runtime URLs ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: The custom API capabilities ,
Required: False ,
}
[
string ,
]
,
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
backendService:
{
Description: The API backend service ,
Required: False ,
}
{
serviceUrl:
{
Description: The service URL ,
Required: False ,
}
string ,
}
,
apiDefinitions:
{
Description: API Definitions ,
Required: False ,
}
{
originalSwaggerUrl:
{
Description: The original swagger URL ,
Required: False ,
}
string ,
modifiedSwaggerUrl:
{
Description: The modified swagger URL ,
Required: False ,
}
string ,
}
,
apiType:
{
Description: The API type ,
Enum:
{
NotSpecified: No description available. ,
Rest: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
wsdlDefinition:
{
Description: The WSDL definition ,
Required: False ,
}
{
url:
{
Description: The WSDL URL ,
Required: False ,
}
string ,
content:
{
Description: The WSDL content ,
Required: False ,
}
string ,
service:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
importMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
}
CustomApis_Get (new)
Description :  Gets a custom API by name for a specific subscription and resource group
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Custom API properties ,
Required: False ,
}
{
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
runtimeUrls:
{
Description: Runtime URLs ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: The custom API capabilities ,
Required: False ,
}
[
string ,
]
,
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
backendService:
{
Description: The API backend service ,
Required: False ,
}
{
serviceUrl:
{
Description: The service URL ,
Required: False ,
}
string ,
}
,
apiDefinitions:
{
Description: API Definitions ,
Required: False ,
}
{
originalSwaggerUrl:
{
Description: The original swagger URL ,
Required: False ,
}
string ,
modifiedSwaggerUrl:
{
Description: The modified swagger URL ,
Required: False ,
}
string ,
}
,
apiType:
{
Description: The API type ,
Enum:
{
NotSpecified: No description available. ,
Rest: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
wsdlDefinition:
{
Description: The WSDL definition ,
Required: False ,
}
{
url:
{
Description: The WSDL URL ,
Required: False ,
}
string ,
content:
{
Description: The WSDL content ,
Required: False ,
}
string ,
service:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
importMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
CustomApis_CreateOrUpdate (new)
Description :  Creates or updates an existing custom API
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/customApis/{apiName}
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group ,
Required: True ,
}
string ,
apiName:
{
Description: API name ,
Required: True ,
}
string ,
customApi:
{
Description: The custom API ,
Required: True ,
}
{
properties:
{
Description: Custom API properties ,
Required: False ,
}
{
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
runtimeUrls:
{
Description: Runtime URLs ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: The custom API capabilities ,
Required: False ,
}
[
string ,
]
,
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
backendService:
{
Description: The API backend service ,
Required: False ,
}
{
serviceUrl:
{
Description: The service URL ,
Required: False ,
}
string ,
}
,
apiDefinitions:
{
Description: API Definitions ,
Required: False ,
}
{
originalSwaggerUrl:
{
Description: The original swagger URL ,
Required: False ,
}
string ,
modifiedSwaggerUrl:
{
Description: The modified swagger URL ,
Required: False ,
}
string ,
}
,
apiType:
{
Description: The API type ,
Enum:
{
NotSpecified: No description available. ,
Rest: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
wsdlDefinition:
{
Description: The WSDL definition ,
Required: False ,
}
{
url:
{
Description: The WSDL URL ,
Required: False ,
}
string ,
content:
{
Description: The WSDL content ,
Required: False ,
}
string ,
service:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
importMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Custom API properties ,
Required: False ,
}
{
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
runtimeUrls:
{
Description: Runtime URLs ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: The custom API capabilities ,
Required: False ,
}
[
string ,
]
,
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
backendService:
{
Description: The API backend service ,
Required: False ,
}
{
serviceUrl:
{
Description: The service URL ,
Required: False ,
}
string ,
}
,
apiDefinitions:
{
Description: API Definitions ,
Required: False ,
}
{
originalSwaggerUrl:
{
Description: The original swagger URL ,
Required: False ,
}
string ,
modifiedSwaggerUrl:
{
Description: The modified swagger URL ,
Required: False ,
}
string ,
}
,
apiType:
{
Description: The API type ,
Enum:
{
NotSpecified: No description available. ,
Rest: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
wsdlDefinition:
{
Description: The WSDL definition ,
Required: False ,
}
{
url:
{
Description: The WSDL URL ,
Required: False ,
}
string ,
content:
{
Description: The WSDL content ,
Required: False ,
}
string ,
service:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
importMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
CustomApis_Update (new)
Description :  Updates an existing custom API's tags
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/customApis/{apiName}
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group ,
Required: True ,
}
string ,
apiName:
{
Description: API name ,
Required: True ,
}
string ,
customApi:
{
Description: The custom API ,
Required: True ,
}
{
properties:
{
Description: Custom API properties ,
Required: False ,
}
{
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
runtimeUrls:
{
Description: Runtime URLs ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: The custom API capabilities ,
Required: False ,
}
[
string ,
]
,
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
backendService:
{
Description: The API backend service ,
Required: False ,
}
{
serviceUrl:
{
Description: The service URL ,
Required: False ,
}
string ,
}
,
apiDefinitions:
{
Description: API Definitions ,
Required: False ,
}
{
originalSwaggerUrl:
{
Description: The original swagger URL ,
Required: False ,
}
string ,
modifiedSwaggerUrl:
{
Description: The modified swagger URL ,
Required: False ,
}
string ,
}
,
apiType:
{
Description: The API type ,
Enum:
{
NotSpecified: No description available. ,
Rest: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
wsdlDefinition:
{
Description: The WSDL definition ,
Required: False ,
}
{
url:
{
Description: The WSDL URL ,
Required: False ,
}
string ,
content:
{
Description: The WSDL content ,
Required: False ,
}
string ,
service:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
importMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Custom API properties ,
Required: False ,
}
{
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
runtimeUrls:
{
Description: Runtime URLs ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: The custom API capabilities ,
Required: False ,
}
[
string ,
]
,
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
backendService:
{
Description: The API backend service ,
Required: False ,
}
{
serviceUrl:
{
Description: The service URL ,
Required: False ,
}
string ,
}
,
apiDefinitions:
{
Description: API Definitions ,
Required: False ,
}
{
originalSwaggerUrl:
{
Description: The original swagger URL ,
Required: False ,
}
string ,
modifiedSwaggerUrl:
{
Description: The modified swagger URL ,
Required: False ,
}
string ,
}
,
apiType:
{
Description: The API type ,
Enum:
{
NotSpecified: No description available. ,
Rest: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
wsdlDefinition:
{
Description: The WSDL definition ,
Required: False ,
}
{
url:
{
Description: The WSDL URL ,
Required: False ,
}
string ,
content:
{
Description: The WSDL content ,
Required: False ,
}
string ,
service:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
importMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
CustomApis_Delete (new)
Description :  Deletes a custom API from the resource group
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}
CustomApis_Move (new)
Description :  Moves a specific custom API
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/customApis/{apiName}/move
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group ,
Required: True ,
}
string ,
apiName:
{
Description: API name ,
Required: True ,
}
string ,
customApiReference:
{
Description: The custom API reference ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
CustomApis_ListWsdlInterfaces (new)
Description :  This returns the list of interfaces in the WSDL
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/listWsdlInterfaces
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
location:
{
Description: The location ,
Required: True ,
}
string ,
wsdlDefinition:
{
Description: WSDL definition ,
Required: True ,
}
{
url:
{
Description: The WSDL URL ,
Required: False ,
}
string ,
content:
{
Description: The WSDL content ,
Required: False ,
}
string ,
service:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
importMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of WSDL interfaces ,
Required: False ,
}
[
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
CustomApis_ExtractApiDefinitionFromWsdl (new)
Description :  Parses the specified WSDL and extracts the API definition
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/extractApiDefinitionFromWsdl
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
location:
{
Description: The location ,
Required: True ,
}
string ,
wsdlDefinition:
{
Description: WSDL definition ,
Required: True ,
}
{
url:
{
Description: The WSDL URL ,
Required: False ,
}
string ,
content:
{
Description: The WSDL content ,
Required: False ,
}
string ,
service:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
importMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}
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 managed APIs ,
Required: False ,
}
[
{
properties:
{
Description: API resource properties ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
metadata:
{
Required: False ,
}
{
source:
{
Description: The source ,
Required: False ,
}
string ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
hideKey:
{
Description: Hide key ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
apiType:
{
Description: The API type ,
Enum:
{
NotSpecified: No description available. ,
Rest: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
wsdlService:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
wsdlImportMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
connectionType:
{
Description: The connection type ,
Required: False ,
}
string ,
}
,
runtimeUrls:
{
Description: Runtime URLs ,
Required: False ,
}
[
string ,
]
,
generalInformation:
{
Description: General information about the API ,
Required: False ,
}
{
iconUrl:
{
Description: The icon URL ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
description:
{
Description: The API description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: URL to the Terms of Use ,
Required: False ,
}
string ,
releaseTag:
{
Description: Release tag ,
Required: False ,
}
string ,
}
,
capabilities:
{
Description: The managed API capabilities ,
Required: False ,
}
[
string ,
]
,
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
backendService:
{
Description: The API backend service ,
Required: False ,
}
{
serviceUrl:
{
Description: The service URL ,
Required: False ,
}
string ,
}
,
policies:
{
Description: Describes the API policies either as embedded content or as a link to uploaded content ,
Required: False ,
}
{
content:
{
Description: API level policies as XML ,
Required: False ,
}
string ,
contentLink:
{
Description: Link to the JSON of the policies ,
Required: False ,
}
string ,
}
,
apiDefinitionUrl:
{
Description: URL where the swagger can be downloaded from ,
Required: False ,
}
string ,
apiDefinitions:
{
Description: API Definitions ,
Required: False ,
}
{
originalSwaggerUrl:
{
Description: The original swagger URL ,
Required: False ,
}
string ,
modifiedSwaggerUrl:
{
Description: The modified swagger URL ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
ManagedApis_Get (new)
Description :  Gets a managed API
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: API resource properties ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
metadata:
{
Required: False ,
}
{
source:
{
Description: The source ,
Required: False ,
}
string ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
hideKey:
{
Description: Hide key ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
apiType:
{
Description: The API type ,
Enum:
{
NotSpecified: No description available. ,
Rest: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
wsdlService:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
wsdlImportMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
connectionType:
{
Description: The connection type ,
Required: False ,
}
string ,
}
,
runtimeUrls:
{
Description: Runtime URLs ,
Required: False ,
}
[
string ,
]
,
generalInformation:
{
Description: General information about the API ,
Required: False ,
}
{
iconUrl:
{
Description: The icon URL ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
description:
{
Description: The API description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: URL to the Terms of Use ,
Required: False ,
}
string ,
releaseTag:
{
Description: Release tag ,
Required: False ,
}
string ,
}
,
capabilities:
{
Description: The managed API capabilities ,
Required: False ,
}
[
string ,
]
,
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
backendService:
{
Description: The API backend service ,
Required: False ,
}
{
serviceUrl:
{
Description: The service URL ,
Required: False ,
}
string ,
}
,
policies:
{
Description: Describes the API policies either as embedded content or as a link to uploaded content ,
Required: False ,
}
{
content:
{
Description: API level policies as XML ,
Required: False ,
}
string ,
contentLink:
{
Description: Link to the JSON of the policies ,
Required: False ,
}
string ,
}
,
apiDefinitionUrl:
{
Description: URL where the swagger can be downloaded from ,
Required: False ,
}
string ,
apiDefinitions:
{
Description: API Definitions ,
Required: False ,
}
{
originalSwaggerUrl:
{
Description: The original swagger URL ,
Required: False ,
}
string ,
modifiedSwaggerUrl:
{
Description: The modified swagger URL ,
Required: False ,
}
string ,
}
,
}
,
}
Connections_List (new)
Description :  Gets a list of connections
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group ,
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 ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of API connections ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
status:
{
Description: The gateway status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Connection error ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: Code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
parameterValues:
{
Description: Dictionary of parameter values ,
Required: False ,
}
object ,
customParameterValues:
{
Description: Dictionary of custom parameter values ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Dictionary of nonsecret parameter values ,
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 ,
api:
{
Required: False ,
}
{
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
name:
{
Description: The name of the API ,
Required: False ,
}
string ,
}
,
testLinks:
{
Description: Links to test the API connection ,
Required: False ,
}
[
{
requestUri:
{
Description: Test link request URI ,
Required: False ,
}
string ,
method:
{
Description: HTTP Method ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
Connections_Get (new)
Description :  Get a specific 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 ,
Required: True ,
}
string ,
connectionName:
{
Description: Connection name ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
status:
{
Description: The gateway status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Connection error ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: Code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
parameterValues:
{
Description: Dictionary of parameter values ,
Required: False ,
}
object ,
customParameterValues:
{
Description: Dictionary of custom parameter values ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Dictionary of nonsecret parameter values ,
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 ,
api:
{
Required: False ,
}
{
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
name:
{
Description: The name of the API ,
Required: False ,
}
string ,
}
,
testLinks:
{
Description: Links to test the API connection ,
Required: False ,
}
[
{
requestUri:
{
Description: Test link request URI ,
Required: False ,
}
string ,
method:
{
Description: HTTP Method ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 ,
Required: True ,
}
string ,
connectionName:
{
Description: Connection name ,
Required: True ,
}
string ,
connection:
{
Description: The connection ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
status:
{
Description: The gateway status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Connection error ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: Code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
parameterValues:
{
Description: Dictionary of parameter values ,
Required: False ,
}
object ,
customParameterValues:
{
Description: Dictionary of custom parameter values ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Dictionary of nonsecret parameter values ,
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 ,
api:
{
Required: False ,
}
{
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
name:
{
Description: The name of the API ,
Required: False ,
}
string ,
}
,
testLinks:
{
Description: Links to test the API connection ,
Required: False ,
}
[
{
requestUri:
{
Description: Test link request URI ,
Required: False ,
}
string ,
method:
{
Description: HTTP Method ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
status:
{
Description: The gateway status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Connection error ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: Code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
parameterValues:
{
Description: Dictionary of parameter values ,
Required: False ,
}
object ,
customParameterValues:
{
Description: Dictionary of custom parameter values ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Dictionary of nonsecret parameter values ,
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 ,
api:
{
Required: False ,
}
{
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
name:
{
Description: The name of the API ,
Required: False ,
}
string ,
}
,
testLinks:
{
Description: Links to test the API connection ,
Required: False ,
}
[
{
requestUri:
{
Description: Test link request URI ,
Required: False ,
}
string ,
method:
{
Description: HTTP Method ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
status:
{
Description: The gateway status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Connection error ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: Code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
parameterValues:
{
Description: Dictionary of parameter values ,
Required: False ,
}
object ,
customParameterValues:
{
Description: Dictionary of custom parameter values ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Dictionary of nonsecret parameter values ,
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 ,
api:
{
Required: False ,
}
{
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
name:
{
Description: The name of the API ,
Required: False ,
}
string ,
}
,
testLinks:
{
Description: Links to test the API connection ,
Required: False ,
}
[
{
requestUri:
{
Description: Test link request URI ,
Required: False ,
}
string ,
method:
{
Description: HTTP Method ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Connections_Update (new)
Description :  Updates a connection's tags
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections/{connectionName}
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group ,
Required: True ,
}
string ,
connectionName:
{
Description: Connection name ,
Required: True ,
}
string ,
connection:
{
Description: The connection ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
status:
{
Description: The gateway status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Connection error ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: Code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
parameterValues:
{
Description: Dictionary of parameter values ,
Required: False ,
}
object ,
customParameterValues:
{
Description: Dictionary of custom parameter values ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Dictionary of nonsecret parameter values ,
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 ,
api:
{
Required: False ,
}
{
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
name:
{
Description: The name of the API ,
Required: False ,
}
string ,
}
,
testLinks:
{
Description: Links to test the API connection ,
Required: False ,
}
[
{
requestUri:
{
Description: Test link request URI ,
Required: False ,
}
string ,
method:
{
Description: HTTP Method ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
status:
{
Description: The gateway status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Connection error ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: Code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
parameterValues:
{
Description: Dictionary of parameter values ,
Required: False ,
}
object ,
customParameterValues:
{
Description: Dictionary of custom parameter values ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Dictionary of nonsecret parameter values ,
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 ,
api:
{
Required: False ,
}
{
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
name:
{
Description: The name of the API ,
Required: False ,
}
string ,
}
,
testLinks:
{
Description: Links to test the API connection ,
Required: False ,
}
[
{
requestUri:
{
Description: Test link request URI ,
Required: False ,
}
string ,
method:
{
Description: HTTP Method ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 ,
Required: True ,
}
string ,
connectionName:
{
Description: 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 ,
Required: True ,
}
string ,
connectionName:
{
Description: Connection name ,
Required: True ,
}
string ,
confirmConsentCode:
{
Description: The consent code confirmation ,
Required: True ,
}
{
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 ,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
ConnectionGateways_List (removed)
Description :  Gets a list of gateways under a subscription
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of connection gateways ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
connectionGatewayInstallation:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
ConnectionGateways_ListByResourceGroup (removed)
Description :  Gets a list of gateways under a subscription and in a specific resource group
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of connection gateways ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
connectionGatewayInstallation:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
ConnectionGateways_Get (removed)
Description :  Gets a specific gateway under a subscription and in a specific resource group
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
connectionGatewayInstallation:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}
ConnectionGateways_CreateOrUpdate (removed)
Description :  Creates or updates a specific gateway for under a subscription and in a specific resource group
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connectionGateways/{connectionGatewayName}
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group ,
Required: True ,
}
string ,
connectionGatewayName:
{
Description: The connection gateway name ,
Required: True ,
}
string ,
connectionGateway:
{
Description: The connection gateway ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
connectionGatewayInstallation:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
connectionGatewayInstallation:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Required: False ,
}
{
connectionGatewayInstallation:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}
ConnectionGateways_Update (removed)
Description :  Updates a connection gateway's tags
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connectionGateways/{connectionGatewayName}
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group ,
Required: True ,
}
string ,
connectionGatewayName:
{
Description: The connection gateway name ,
Required: True ,
}
string ,
connectionGateway:
{
Description: The connection gateway ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
connectionGatewayInstallation:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
connectionGatewayInstallation:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}
ConnectionGateways_Delete (removed)
Description :  Deletes a specific gateway for under a subscription and in a specific resource group
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}
ConnectionGatewayInstallations_List (removed)
Description :  Gets a list of installed gateways that the user is an admin of, in a specific subscription and at a certain location
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Collection of connection gateway installations ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
connectionGateway:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
ConnectionGatewayInstallations_Get (removed)
Description :  Get a specific installed gateway that the user is an admin of, in a specific subscription and at a certain location
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
connectionGateway:
{
Description: The gateway installation reference ,
Required: False ,
}
{
location:
{
Description: Resource reference location ,
Required: False ,
}
string ,
name:
{
Description: Resource reference name ,
Required: False ,
}
string ,
}
,
contactInformation:
{
Description: The gateway admin ,
Required: False ,
}
[
string ,
]
,
displayName:
{
Description: The gateway display name ,
Required: False ,
}
string ,
description:
{
Description: The gateway description ,
Required: False ,
}
string ,
machineName:
{
Description: The machine name of the gateway ,
Required: False ,
}
string ,
status:
{
Description: The gateway status ,
Required: False ,
}
object ,
backendUri:
{
Description: The URI of the backend ,
Required: False ,
}
string ,
}
,
}
CustomApis_List (removed)
Description :  Gets a list of all custom APIs for a subscription id
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/customApis
{
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 ,
skiptoken:
{
Description: Skip Token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of custom APIs ,
Required: False ,
}
[
{
properties:
{
Description: Custom API properties ,
Required: False ,
}
{
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
runtimeUrls:
{
Description: Runtime URLs ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: The custom API capabilities ,
Required: False ,
}
[
string ,
]
,
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
backendService:
{
Description: The API backend service ,
Required: False ,
}
{
serviceUrl:
{
Description: The service URL ,
Required: False ,
}
string ,
}
,
apiDefinitions:
{
Description: API Definitions ,
Required: False ,
}
{
originalSwaggerUrl:
{
Description: The original swagger URL ,
Required: False ,
}
string ,
modifiedSwaggerUrl:
{
Description: The modified swagger URL ,
Required: False ,
}
string ,
}
,
apiType:
{
Description: The API type ,
Enum:
{
NotSpecified: No description available. ,
Rest: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
wsdlDefinition:
{
Description: The WSDL definition ,
Required: False ,
}
{
url:
{
Description: The WSDL URL ,
Required: False ,
}
string ,
content:
{
Description: The WSDL content ,
Required: False ,
}
string ,
service:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
importMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
}
CustomApis_ListByResourceGroup (removed)
Description :  Gets a list of all custom APIs in a subscription for a specific resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/customApis
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group ,
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 ,
skiptoken:
{
Description: Skip Token ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of custom APIs ,
Required: False ,
}
[
{
properties:
{
Description: Custom API properties ,
Required: False ,
}
{
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
runtimeUrls:
{
Description: Runtime URLs ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: The custom API capabilities ,
Required: False ,
}
[
string ,
]
,
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
backendService:
{
Description: The API backend service ,
Required: False ,
}
{
serviceUrl:
{
Description: The service URL ,
Required: False ,
}
string ,
}
,
apiDefinitions:
{
Description: API Definitions ,
Required: False ,
}
{
originalSwaggerUrl:
{
Description: The original swagger URL ,
Required: False ,
}
string ,
modifiedSwaggerUrl:
{
Description: The modified swagger URL ,
Required: False ,
}
string ,
}
,
apiType:
{
Description: The API type ,
Enum:
{
NotSpecified: No description available. ,
Rest: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
wsdlDefinition:
{
Description: The WSDL definition ,
Required: False ,
}
{
url:
{
Description: The WSDL URL ,
Required: False ,
}
string ,
content:
{
Description: The WSDL content ,
Required: False ,
}
string ,
service:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
importMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
}
CustomApis_Get (removed)
Description :  Gets a custom API by name for a specific subscription and resource group
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Custom API properties ,
Required: False ,
}
{
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
runtimeUrls:
{
Description: Runtime URLs ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: The custom API capabilities ,
Required: False ,
}
[
string ,
]
,
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
backendService:
{
Description: The API backend service ,
Required: False ,
}
{
serviceUrl:
{
Description: The service URL ,
Required: False ,
}
string ,
}
,
apiDefinitions:
{
Description: API Definitions ,
Required: False ,
}
{
originalSwaggerUrl:
{
Description: The original swagger URL ,
Required: False ,
}
string ,
modifiedSwaggerUrl:
{
Description: The modified swagger URL ,
Required: False ,
}
string ,
}
,
apiType:
{
Description: The API type ,
Enum:
{
NotSpecified: No description available. ,
Rest: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
wsdlDefinition:
{
Description: The WSDL definition ,
Required: False ,
}
{
url:
{
Description: The WSDL URL ,
Required: False ,
}
string ,
content:
{
Description: The WSDL content ,
Required: False ,
}
string ,
service:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
importMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
CustomApis_CreateOrUpdate (removed)
Description :  Creates or updates an existing custom API
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/customApis/{apiName}
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group ,
Required: True ,
}
string ,
apiName:
{
Description: API name ,
Required: True ,
}
string ,
customApi:
{
Description: The custom API ,
Required: True ,
}
{
properties:
{
Description: Custom API properties ,
Required: False ,
}
{
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
runtimeUrls:
{
Description: Runtime URLs ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: The custom API capabilities ,
Required: False ,
}
[
string ,
]
,
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
backendService:
{
Description: The API backend service ,
Required: False ,
}
{
serviceUrl:
{
Description: The service URL ,
Required: False ,
}
string ,
}
,
apiDefinitions:
{
Description: API Definitions ,
Required: False ,
}
{
originalSwaggerUrl:
{
Description: The original swagger URL ,
Required: False ,
}
string ,
modifiedSwaggerUrl:
{
Description: The modified swagger URL ,
Required: False ,
}
string ,
}
,
apiType:
{
Description: The API type ,
Enum:
{
NotSpecified: No description available. ,
Rest: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
wsdlDefinition:
{
Description: The WSDL definition ,
Required: False ,
}
{
url:
{
Description: The WSDL URL ,
Required: False ,
}
string ,
content:
{
Description: The WSDL content ,
Required: False ,
}
string ,
service:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
importMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Custom API properties ,
Required: False ,
}
{
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
runtimeUrls:
{
Description: Runtime URLs ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: The custom API capabilities ,
Required: False ,
}
[
string ,
]
,
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
backendService:
{
Description: The API backend service ,
Required: False ,
}
{
serviceUrl:
{
Description: The service URL ,
Required: False ,
}
string ,
}
,
apiDefinitions:
{
Description: API Definitions ,
Required: False ,
}
{
originalSwaggerUrl:
{
Description: The original swagger URL ,
Required: False ,
}
string ,
modifiedSwaggerUrl:
{
Description: The modified swagger URL ,
Required: False ,
}
string ,
}
,
apiType:
{
Description: The API type ,
Enum:
{
NotSpecified: No description available. ,
Rest: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
wsdlDefinition:
{
Description: The WSDL definition ,
Required: False ,
}
{
url:
{
Description: The WSDL URL ,
Required: False ,
}
string ,
content:
{
Description: The WSDL content ,
Required: False ,
}
string ,
service:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
importMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
CustomApis_Update (removed)
Description :  Updates an existing custom API's tags
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/customApis/{apiName}
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group ,
Required: True ,
}
string ,
apiName:
{
Description: API name ,
Required: True ,
}
string ,
customApi:
{
Description: The custom API ,
Required: True ,
}
{
properties:
{
Description: Custom API properties ,
Required: False ,
}
{
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
runtimeUrls:
{
Description: Runtime URLs ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: The custom API capabilities ,
Required: False ,
}
[
string ,
]
,
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
backendService:
{
Description: The API backend service ,
Required: False ,
}
{
serviceUrl:
{
Description: The service URL ,
Required: False ,
}
string ,
}
,
apiDefinitions:
{
Description: API Definitions ,
Required: False ,
}
{
originalSwaggerUrl:
{
Description: The original swagger URL ,
Required: False ,
}
string ,
modifiedSwaggerUrl:
{
Description: The modified swagger URL ,
Required: False ,
}
string ,
}
,
apiType:
{
Description: The API type ,
Enum:
{
NotSpecified: No description available. ,
Rest: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
wsdlDefinition:
{
Description: The WSDL definition ,
Required: False ,
}
{
url:
{
Description: The WSDL URL ,
Required: False ,
}
string ,
content:
{
Description: The WSDL content ,
Required: False ,
}
string ,
service:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
importMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Custom API properties ,
Required: False ,
}
{
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
runtimeUrls:
{
Description: Runtime URLs ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: The custom API capabilities ,
Required: False ,
}
[
string ,
]
,
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
backendService:
{
Description: The API backend service ,
Required: False ,
}
{
serviceUrl:
{
Description: The service URL ,
Required: False ,
}
string ,
}
,
apiDefinitions:
{
Description: API Definitions ,
Required: False ,
}
{
originalSwaggerUrl:
{
Description: The original swagger URL ,
Required: False ,
}
string ,
modifiedSwaggerUrl:
{
Description: The modified swagger URL ,
Required: False ,
}
string ,
}
,
apiType:
{
Description: The API type ,
Enum:
{
NotSpecified: No description available. ,
Rest: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
wsdlDefinition:
{
Description: The WSDL definition ,
Required: False ,
}
{
url:
{
Description: The WSDL URL ,
Required: False ,
}
string ,
content:
{
Description: The WSDL content ,
Required: False ,
}
string ,
service:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
importMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
CustomApis_Delete (removed)
Description :  Deletes a custom API from the resource group
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}
CustomApis_Move (removed)
Description :  Moves a specific custom API
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/customApis/{apiName}/move
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group ,
Required: True ,
}
string ,
apiName:
{
Description: API name ,
Required: True ,
}
string ,
customApiReference:
{
Description: The custom API reference ,
Required: True ,
}
{
name:
{
Required: False ,
}
string ,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
CustomApis_ListWsdlInterfaces (removed)
Description :  This returns the list of interfaces in the WSDL
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/listWsdlInterfaces
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
location:
{
Description: The location ,
Required: True ,
}
string ,
wsdlDefinition:
{
Description: WSDL definition ,
Required: True ,
}
{
url:
{
Description: The WSDL URL ,
Required: False ,
}
string ,
content:
{
Description: The WSDL content ,
Required: False ,
}
string ,
service:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
importMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of WSDL interfaces ,
Required: False ,
}
[
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
CustomApis_ExtractApiDefinitionFromWsdl (removed)
Description :  Parses the specified WSDL and extracts the API definition
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/extractApiDefinitionFromWsdl
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
location:
{
Description: The location ,
Required: True ,
}
string ,
wsdlDefinition:
{
Description: WSDL definition ,
Required: True ,
}
{
url:
{
Description: The WSDL URL ,
Required: False ,
}
string ,
content:
{
Description: The WSDL content ,
Required: False ,
}
string ,
service:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
importMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: 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 managed APIs ,
Required: False ,
}
[
{
properties:
{
Description: API resource properties ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
metadata:
{
Required: False ,
}
{
source:
{
Description: The source ,
Required: False ,
}
string ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
hideKey:
{
Description: Hide key ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
apiType:
{
Description: The API type ,
Enum:
{
NotSpecified: No description available. ,
Rest: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
wsdlService:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
wsdlImportMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
connectionType:
{
Description: The connection type ,
Required: False ,
}
string ,
}
,
runtimeUrls:
{
Description: Runtime URLs ,
Required: False ,
}
[
string ,
]
,
generalInformation:
{
Description: General information about the API ,
Required: False ,
}
{
iconUrl:
{
Description: The icon URL ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
description:
{
Description: The API description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: URL to the Terms of Use ,
Required: False ,
}
string ,
releaseTag:
{
Description: Release tag ,
Required: False ,
}
string ,
}
,
capabilities:
{
Description: The managed API capabilities ,
Required: False ,
}
[
string ,
]
,
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
backendService:
{
Description: The API backend service ,
Required: False ,
}
{
serviceUrl:
{
Description: The service URL ,
Required: False ,
}
string ,
}
,
policies:
{
Description: Describes the API policies either as embedded content or as a link to uploaded content ,
Required: False ,
}
{
content:
{
Description: API level policies as XML ,
Required: False ,
}
string ,
contentLink:
{
Description: Link to the JSON of the policies ,
Required: False ,
}
string ,
}
,
apiDefinitionUrl:
{
Description: URL where the swagger can be downloaded from ,
Required: False ,
}
string ,
apiDefinitions:
{
Description: API Definitions ,
Required: False ,
}
{
originalSwaggerUrl:
{
Description: The original swagger URL ,
Required: False ,
}
string ,
modifiedSwaggerUrl:
{
Description: The modified swagger URL ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
ManagedApis_Get (removed)
Description :  Gets a managed API
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: API resource properties ,
Required: False ,
}
{
name:
{
Required: False ,
}
string ,
connectionParameters:
{
Description: Connection parameters ,
Required: False ,
}
object ,
metadata:
{
Required: False ,
}
{
source:
{
Description: The source ,
Required: False ,
}
string ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
hideKey:
{
Description: Hide key ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
apiType:
{
Description: The API type ,
Enum:
{
NotSpecified: No description available. ,
Rest: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
wsdlService:
{
Description: The service with name and endpoint names ,
Required: False ,
}
{
qualifiedName:
{
Description: The service's qualified name ,
Required: True ,
}
string ,
endpointQualifiedNames:
{
Description: List of the endpoints' qualified names ,
Required: False ,
}
[
string ,
]
,
}
,
wsdlImportMethod:
{
Description: The WSDL import method ,
Enum:
{
NotSpecified: No description available. ,
SoapToRest: No description available. ,
SoapPassThrough: No description available. ,
}
,
Required: False ,
}
enum ,
connectionType:
{
Description: The connection type ,
Required: False ,
}
string ,
}
,
runtimeUrls:
{
Description: Runtime URLs ,
Required: False ,
}
[
string ,
]
,
generalInformation:
{
Description: General information about the API ,
Required: False ,
}
{
iconUrl:
{
Description: The icon URL ,
Required: False ,
}
string ,
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
description:
{
Description: The API description ,
Required: False ,
}
string ,
termsOfUseUrl:
{
Description: URL to the Terms of Use ,
Required: False ,
}
string ,
releaseTag:
{
Description: Release tag ,
Required: False ,
}
string ,
}
,
capabilities:
{
Description: The managed API capabilities ,
Required: False ,
}
[
string ,
]
,
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
backendService:
{
Description: The API backend service ,
Required: False ,
}
{
serviceUrl:
{
Description: The service URL ,
Required: False ,
}
string ,
}
,
policies:
{
Description: Describes the API policies either as embedded content or as a link to uploaded content ,
Required: False ,
}
{
content:
{
Description: API level policies as XML ,
Required: False ,
}
string ,
contentLink:
{
Description: Link to the JSON of the policies ,
Required: False ,
}
string ,
}
,
apiDefinitionUrl:
{
Description: URL where the swagger can be downloaded from ,
Required: False ,
}
string ,
apiDefinitions:
{
Description: API Definitions ,
Required: False ,
}
{
originalSwaggerUrl:
{
Description: The original swagger URL ,
Required: False ,
}
string ,
modifiedSwaggerUrl:
{
Description: The modified swagger URL ,
Required: False ,
}
string ,
}
,
}
,
}
Connections_List (removed)
Description :  Gets a list of connections
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group ,
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 ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of API connections ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
status:
{
Description: The gateway status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Connection error ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: Code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
parameterValues:
{
Description: Dictionary of parameter values ,
Required: False ,
}
object ,
customParameterValues:
{
Description: Dictionary of custom parameter values ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Dictionary of nonsecret parameter values ,
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 ,
api:
{
Required: False ,
}
{
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
name:
{
Description: The name of the API ,
Required: False ,
}
string ,
}
,
testLinks:
{
Description: Links to test the API connection ,
Required: False ,
}
[
{
requestUri:
{
Description: Test link request URI ,
Required: False ,
}
string ,
method:
{
Description: HTTP Method ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
Connections_Get (removed)
Description :  Get a specific 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 ,
Required: True ,
}
string ,
connectionName:
{
Description: Connection name ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
status:
{
Description: The gateway status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Connection error ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: Code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
parameterValues:
{
Description: Dictionary of parameter values ,
Required: False ,
}
object ,
customParameterValues:
{
Description: Dictionary of custom parameter values ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Dictionary of nonsecret parameter values ,
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 ,
api:
{
Required: False ,
}
{
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
name:
{
Description: The name of the API ,
Required: False ,
}
string ,
}
,
testLinks:
{
Description: Links to test the API connection ,
Required: False ,
}
[
{
requestUri:
{
Description: Test link request URI ,
Required: False ,
}
string ,
method:
{
Description: HTTP Method ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 ,
Required: True ,
}
string ,
connectionName:
{
Description: Connection name ,
Required: True ,
}
string ,
connection:
{
Description: The connection ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
status:
{
Description: The gateway status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Connection error ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: Code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
parameterValues:
{
Description: Dictionary of parameter values ,
Required: False ,
}
object ,
customParameterValues:
{
Description: Dictionary of custom parameter values ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Dictionary of nonsecret parameter values ,
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 ,
api:
{
Required: False ,
}
{
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
name:
{
Description: The name of the API ,
Required: False ,
}
string ,
}
,
testLinks:
{
Description: Links to test the API connection ,
Required: False ,
}
[
{
requestUri:
{
Description: Test link request URI ,
Required: False ,
}
string ,
method:
{
Description: HTTP Method ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
status:
{
Description: The gateway status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Connection error ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: Code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
parameterValues:
{
Description: Dictionary of parameter values ,
Required: False ,
}
object ,
customParameterValues:
{
Description: Dictionary of custom parameter values ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Dictionary of nonsecret parameter values ,
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 ,
api:
{
Required: False ,
}
{
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
name:
{
Description: The name of the API ,
Required: False ,
}
string ,
}
,
testLinks:
{
Description: Links to test the API connection ,
Required: False ,
}
[
{
requestUri:
{
Description: Test link request URI ,
Required: False ,
}
string ,
method:
{
Description: HTTP Method ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
status:
{
Description: The gateway status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Connection error ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: Code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
parameterValues:
{
Description: Dictionary of parameter values ,
Required: False ,
}
object ,
customParameterValues:
{
Description: Dictionary of custom parameter values ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Dictionary of nonsecret parameter values ,
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 ,
api:
{
Required: False ,
}
{
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
name:
{
Description: The name of the API ,
Required: False ,
}
string ,
}
,
testLinks:
{
Description: Links to test the API connection ,
Required: False ,
}
[
{
requestUri:
{
Description: Test link request URI ,
Required: False ,
}
string ,
method:
{
Description: HTTP Method ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Connections_Update (removed)
Description :  Updates a connection's tags
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections/{connectionName}
{
subscriptionId:
{
Description: Subscription Id ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group ,
Required: True ,
}
string ,
connectionName:
{
Description: Connection name ,
Required: True ,
}
string ,
connection:
{
Description: The connection ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
status:
{
Description: The gateway status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Connection error ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: Code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
parameterValues:
{
Description: Dictionary of parameter values ,
Required: False ,
}
object ,
customParameterValues:
{
Description: Dictionary of custom parameter values ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Dictionary of nonsecret parameter values ,
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 ,
api:
{
Required: False ,
}
{
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
name:
{
Description: The name of the API ,
Required: False ,
}
string ,
}
,
testLinks:
{
Description: Links to test the API connection ,
Required: False ,
}
[
{
requestUri:
{
Description: Test link request URI ,
Required: False ,
}
string ,
method:
{
Description: HTTP Method ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
displayName:
{
Description: Display name ,
Required: False ,
}
string ,
statuses:
{
Description: Status of the connection ,
Required: False ,
}
[
{
status:
{
Description: The gateway status ,
Required: False ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
error:
{
Description: Connection error ,
Required: False ,
}
{
properties:
{
Required: False ,
}
{
code:
{
Description: Code of the status ,
Required: False ,
}
string ,
message:
{
Description: Description of the status ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
parameterValues:
{
Description: Dictionary of parameter values ,
Required: False ,
}
object ,
customParameterValues:
{
Description: Dictionary of custom parameter values ,
Required: False ,
}
object ,
nonSecretParameterValues:
{
Description: Dictionary of nonsecret parameter values ,
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 ,
api:
{
Required: False ,
}
{
swagger:
{
Description: The JSON representation of the swagger ,
Required: False ,
}
object ,
brandColor:
{
Description: Brand color ,
Required: False ,
}
string ,
description:
{
Description: The custom API description ,
Required: False ,
}
string ,
displayName:
{
Description: The display name ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon URI ,
Required: False ,
}
string ,
name:
{
Description: The name of the API ,
Required: False ,
}
string ,
}
,
testLinks:
{
Description: Links to test the API connection ,
Required: False ,
}
[
{
requestUri:
{
Description: Test link request URI ,
Required: False ,
}
string ,
method:
{
Description: HTTP Method ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
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 ,
Required: True ,
}
string ,
connectionName:
{
Description: 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 ,
Required: True ,
}
string ,
connectionName:
{
Description: Connection name ,
Required: True ,
}
string ,
confirmConsentCode:
{
Description: The consent code confirmation ,
Required: True ,
}
{
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 ,
}
,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}