Microsoft.Web customApis 2016-06-01
Bicep resource definition
The customApis resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Web/customApis resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Web/customApis@2016-06-01' = {
etag: 'string'
location: 'string'
name: 'string'
properties: {
apiDefinitions: {
modifiedSwaggerUrl: 'string'
originalSwaggerUrl: 'string'
}
apiType: 'string'
backendService: {
serviceUrl: 'string'
}
brandColor: 'string'
capabilities: [
'string'
]
connectionParameters: {
{customized property}: {
oAuthSettings: {
clientId: 'string'
clientSecret: 'string'
customParameters: {
{customized property}: {
options: any(Azure.Bicep.Types.Concrete.AnyType)
uiDefinition: any(Azure.Bicep.Types.Concrete.AnyType)
value: 'string'
}
}
identityProvider: 'string'
properties: any(Azure.Bicep.Types.Concrete.AnyType)
redirectUrl: 'string'
scopes: [
'string'
]
}
type: 'string'
}
}
description: 'string'
displayName: 'string'
iconUri: 'string'
runtimeUrls: [
'string'
]
swagger: any(Azure.Bicep.Types.Concrete.AnyType)
wsdlDefinition: {
content: 'string'
importMethod: 'string'
service: {
endpointQualifiedNames: [
'string'
]
qualifiedName: 'string'
}
url: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property values
ApiOAuthSettings
| Name | Description | Value |
|---|---|---|
| clientId | Resource provider client id | string |
| clientSecret | Client Secret needed for OAuth | string |
| customParameters | OAuth parameters key is the name of parameter | ApiOAuthSettingsCustomParameters |
| identityProvider | Identity provider | string |
| properties | Read only properties for this oauth setting. | any |
| redirectUrl | Url | string |
| scopes | OAuth scopes | string[] |
ApiOAuthSettingsCustomParameters
| Name | Description | Value |
|---|
ApiOAuthSettingsParameter
| Name | Description | Value |
|---|---|---|
| options | Options available to this parameter | any |
| uiDefinition | UI definitions per culture as caller can specify the culture | any |
| value | Value of the setting | string |
ApiResourceBackendService
| Name | Description | Value |
|---|---|---|
| serviceUrl | The service URL | string |
ApiResourceDefinitions
| Name | Description | Value |
|---|---|---|
| modifiedSwaggerUrl | The modified swagger URL | string |
| originalSwaggerUrl | The original swagger URL | string |
ConnectionParameter
| Name | Description | Value |
|---|---|---|
| oAuthSettings | OAuth settings for the connection provider | ApiOAuthSettings |
| type | Type of the parameter | 'array' 'bool' 'connection' 'int' 'oauthSetting' 'object' 'secureobject' 'securestring' 'string' |
CustomApiPropertiesDefinition
| Name | Description | Value |
|---|---|---|
| apiDefinitions | API Definitions | ApiResourceDefinitions |
| apiType | The API type | 'NotSpecified' 'Rest' 'Soap' |
| backendService | The API backend service | ApiResourceBackendService |
| brandColor | Brand color | string |
| capabilities | The custom API capabilities | string[] |
| connectionParameters | Connection parameters | CustomApiPropertiesDefinitionConnectionParameters |
| description | The custom API description | string |
| displayName | The display name | string |
| iconUri | The icon URI | string |
| runtimeUrls | Runtime URLs | string[] |
| swagger | The JSON representation of the swagger | any |
| wsdlDefinition | The WSDL definition | WsdlDefinition |
CustomApiPropertiesDefinitionConnectionParameters
| Name | Description | Value |
|---|
Microsoft.Web/customApis
| Name | Description | Value |
|---|---|---|
| etag | Resource ETag | string |
| location | Resource location | string |
| name | The resource name | string (required) |
| properties | Custom API properties | CustomApiPropertiesDefinition |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
TagsDictionary
| Name | Description | Value |
|---|
WsdlDefinition
| Name | Description | Value |
|---|---|---|
| content | The WSDL content | string |
| importMethod | The WSDL import method | 'NotSpecified' 'SoapPassThrough' 'SoapToRest' |
| service | The service with name and endpoint names | WsdlService |
| url | The WSDL URL | string |
WsdlService
| Name | Description | Value |
|---|---|---|
| endpointQualifiedNames | List of the endpoints' qualified names | string[] |
| qualifiedName | The service's qualified name | string (required) |
ARM template resource definition
The customApis resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Web/customApis resource, add the following JSON to your template.
{
"type": "Microsoft.Web/customApis",
"apiVersion": "2016-06-01",
"name": "string",
"etag": "string",
"location": "string",
"properties": {
"apiDefinitions": {
"modifiedSwaggerUrl": "string",
"originalSwaggerUrl": "string"
},
"apiType": "string",
"backendService": {
"serviceUrl": "string"
},
"brandColor": "string",
"capabilities": [ "string" ],
"connectionParameters": {
"{customized property}": {
"oAuthSettings": {
"clientId": "string",
"clientSecret": "string",
"customParameters": {
"{customized property}": {
"options": {},
"uiDefinition": {},
"value": "string"
}
},
"identityProvider": "string",
"properties": {},
"redirectUrl": "string",
"scopes": [ "string" ]
},
"type": "string"
}
},
"description": "string",
"displayName": "string",
"iconUri": "string",
"runtimeUrls": [ "string" ],
"swagger": {},
"wsdlDefinition": {
"content": "string",
"importMethod": "string",
"service": {
"endpointQualifiedNames": [ "string" ],
"qualifiedName": "string"
},
"url": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property values
ApiOAuthSettings
| Name | Description | Value |
|---|---|---|
| clientId | Resource provider client id | string |
| clientSecret | Client Secret needed for OAuth | string |
| customParameters | OAuth parameters key is the name of parameter | ApiOAuthSettingsCustomParameters |
| identityProvider | Identity provider | string |
| properties | Read only properties for this oauth setting. | any |
| redirectUrl | Url | string |
| scopes | OAuth scopes | string[] |
ApiOAuthSettingsCustomParameters
| Name | Description | Value |
|---|
ApiOAuthSettingsParameter
| Name | Description | Value |
|---|---|---|
| options | Options available to this parameter | any |
| uiDefinition | UI definitions per culture as caller can specify the culture | any |
| value | Value of the setting | string |
ApiResourceBackendService
| Name | Description | Value |
|---|---|---|
| serviceUrl | The service URL | string |
ApiResourceDefinitions
| Name | Description | Value |
|---|---|---|
| modifiedSwaggerUrl | The modified swagger URL | string |
| originalSwaggerUrl | The original swagger URL | string |
ConnectionParameter
| Name | Description | Value |
|---|---|---|
| oAuthSettings | OAuth settings for the connection provider | ApiOAuthSettings |
| type | Type of the parameter | 'array' 'bool' 'connection' 'int' 'oauthSetting' 'object' 'secureobject' 'securestring' 'string' |
CustomApiPropertiesDefinition
| Name | Description | Value |
|---|---|---|
| apiDefinitions | API Definitions | ApiResourceDefinitions |
| apiType | The API type | 'NotSpecified' 'Rest' 'Soap' |
| backendService | The API backend service | ApiResourceBackendService |
| brandColor | Brand color | string |
| capabilities | The custom API capabilities | string[] |
| connectionParameters | Connection parameters | CustomApiPropertiesDefinitionConnectionParameters |
| description | The custom API description | string |
| displayName | The display name | string |
| iconUri | The icon URI | string |
| runtimeUrls | Runtime URLs | string[] |
| swagger | The JSON representation of the swagger | any |
| wsdlDefinition | The WSDL definition | WsdlDefinition |
CustomApiPropertiesDefinitionConnectionParameters
| Name | Description | Value |
|---|
Microsoft.Web/customApis
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2016-06-01' |
| etag | Resource ETag | string |
| location | Resource location | string |
| name | The resource name | string (required) |
| properties | Custom API properties | CustomApiPropertiesDefinition |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Web/customApis' |
TagsDictionary
| Name | Description | Value |
|---|
WsdlDefinition
| Name | Description | Value |
|---|---|---|
| content | The WSDL content | string |
| importMethod | The WSDL import method | 'NotSpecified' 'SoapPassThrough' 'SoapToRest' |
| service | The service with name and endpoint names | WsdlService |
| url | The WSDL URL | string |
WsdlService
| Name | Description | Value |
|---|---|---|
| endpointQualifiedNames | List of the endpoints' qualified names | string[] |
| qualifiedName | The service's qualified name | string (required) |
Terraform (AzAPI provider) resource definition
The customApis resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Web/customApis resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Web/customApis@2016-06-01"
name = "string"
etag = "string"
location = "string"
body = jsonencode({
properties = {
apiDefinitions = {
modifiedSwaggerUrl = "string"
originalSwaggerUrl = "string"
}
apiType = "string"
backendService = {
serviceUrl = "string"
}
brandColor = "string"
capabilities = [
"string"
]
connectionParameters = {
{customized property} = {
oAuthSettings = {
clientId = "string"
clientSecret = "string"
customParameters = {
{customized property} = {
options = ?
uiDefinition = ?
value = "string"
}
}
identityProvider = "string"
properties = ?
redirectUrl = "string"
scopes = [
"string"
]
}
type = "string"
}
}
description = "string"
displayName = "string"
iconUri = "string"
runtimeUrls = [
"string"
]
swagger = ?
wsdlDefinition = {
content = "string"
importMethod = "string"
service = {
endpointQualifiedNames = [
"string"
]
qualifiedName = "string"
}
url = "string"
}
}
})
tags = {
{customized property} = "string"
}
}
Property values
ApiOAuthSettings
| Name | Description | Value |
|---|---|---|
| clientId | Resource provider client id | string |
| clientSecret | Client Secret needed for OAuth | string |
| customParameters | OAuth parameters key is the name of parameter | ApiOAuthSettingsCustomParameters |
| identityProvider | Identity provider | string |
| properties | Read only properties for this oauth setting. | any |
| redirectUrl | Url | string |
| scopes | OAuth scopes | string[] |
ApiOAuthSettingsCustomParameters
| Name | Description | Value |
|---|
ApiOAuthSettingsParameter
| Name | Description | Value |
|---|---|---|
| options | Options available to this parameter | any |
| uiDefinition | UI definitions per culture as caller can specify the culture | any |
| value | Value of the setting | string |
ApiResourceBackendService
| Name | Description | Value |
|---|---|---|
| serviceUrl | The service URL | string |
ApiResourceDefinitions
| Name | Description | Value |
|---|---|---|
| modifiedSwaggerUrl | The modified swagger URL | string |
| originalSwaggerUrl | The original swagger URL | string |
ConnectionParameter
| Name | Description | Value |
|---|---|---|
| oAuthSettings | OAuth settings for the connection provider | ApiOAuthSettings |
| type | Type of the parameter | 'array' 'bool' 'connection' 'int' 'oauthSetting' 'object' 'secureobject' 'securestring' 'string' |
CustomApiPropertiesDefinition
| Name | Description | Value |
|---|---|---|
| apiDefinitions | API Definitions | ApiResourceDefinitions |
| apiType | The API type | 'NotSpecified' 'Rest' 'Soap' |
| backendService | The API backend service | ApiResourceBackendService |
| brandColor | Brand color | string |
| capabilities | The custom API capabilities | string[] |
| connectionParameters | Connection parameters | CustomApiPropertiesDefinitionConnectionParameters |
| description | The custom API description | string |
| displayName | The display name | string |
| iconUri | The icon URI | string |
| runtimeUrls | Runtime URLs | string[] |
| swagger | The JSON representation of the swagger | any |
| wsdlDefinition | The WSDL definition | WsdlDefinition |
CustomApiPropertiesDefinitionConnectionParameters
| Name | Description | Value |
|---|
Microsoft.Web/customApis
| Name | Description | Value |
|---|---|---|
| etag | Resource ETag | string |
| location | Resource location | string |
| name | The resource name | string (required) |
| properties | Custom API properties | CustomApiPropertiesDefinition |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Web/customApis@2016-06-01" |
TagsDictionary
| Name | Description | Value |
|---|
WsdlDefinition
| Name | Description | Value |
|---|---|---|
| content | The WSDL content | string |
| importMethod | The WSDL import method | 'NotSpecified' 'SoapPassThrough' 'SoapToRest' |
| service | The service with name and endpoint names | WsdlService |
| url | The WSDL URL | string |
WsdlService
| Name | Description | Value |
|---|---|---|
| endpointQualifiedNames | List of the endpoints' qualified names | string[] |
| qualifiedName | The service's qualified name | string (required) |