Microsoft.Web customApis 2016-06-01

• 最新
• 2016-06-01

Bicep リソース定義

customApis リソースの種類は、次をターゲットとする操作でデプロイできます。

• リソース グループ - リソース グループのデプロイ コマンドを参照してください

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Web/customApis リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Web/customApis@2016-06-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  etag: 'string'
  properties: {
    apiDefinitions: {
      modifiedSwaggerUrl: 'string'
      originalSwaggerUrl: 'string'
    }
    apiType: 'string'
    backendService: {
      serviceUrl: 'string'
    }
    brandColor: 'string'
    capabilities: [
      'string'
    ]
    connectionParameters: {}
    description: 'string'
    displayName: 'string'
    iconUri: 'string'
    runtimeUrls: [
      'string'
    ]
    swagger: any()
    wsdlDefinition: {
      content: 'string'
      importMethod: 'string'
      service: {
        endpointQualifiedNames: [
          'string'
        ]
        qualifiedName: 'string'
      }
      url: 'string'
      content: 'string'
      importMethod: 'string'
      service: {
        endpointQualifiedNames: [
          'string'
        ]
        qualifiedName: 'string'
      }
      url: 'string'
    }
  }
}

プロパティ値

customApis

名前	説明	値
name	リソース名	string (必須)
location	リソースの場所	string
tags	リソース タグ	タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
etag	リソース ETag	string
properties	カスタム API のプロパティ	CustomApiPropertiesDefinition

CustomApiPropertiesDefinition

名前	説明	値
apiDefinitions	API 定義	ApiResourceDefinitions
apiType	API の種類	'NotSpecified' 'Rest' 'Soap'
backendService	API バックエンド サービス	ApiResourceBackendService
brandColor	ブランドの色	string
capabilities	カスタム API 機能	string[]
connectionParameters	接続パラメーター	object
description	カスタム API の説明	string
displayName	表示名	string
iconUri	アイコン URI	string
runtimeUrls	ランタイム URL	string[]
Swagger	swagger の JSON 表現	Bicep の場合は、 any() 関数を使用できます。
wsdlDefinition	WSDL 定義	WsdlDefinition

ApiResourceDefinitions

名前	説明	値
modifiedSwaggerUrl	変更された swagger URL	string
originalSwaggerUrl	元の swagger URL	string

ApiResourceBackendService

名前	説明	値
serviceUrl	サービス URL	string

WsdlDefinition

名前	説明	値
content	WSDL コンテンツ	string
importMethod	WSDL インポート メソッド	'NotSpecified' 'SoapPassThrough' 'SoapToRest'
サービス (service)	名前とエンドポイント名を持つサービス	WsdlService
url	The WSDL URL	string
コンテンツ	WSDL コンテンツ	string
importMethod	WSDL インポート メソッド	'NotSpecified' 'SoapPassThrough' 'SoapToRest'
サービス (service)	名前とエンドポイント名を持つサービス	WsdlService
url	The WSDL URL	string

WsdlService

名前	説明	値
endpointQualifiedNames	エンドポイントの修飾名の一覧	string[]
qualifiedName	サービスの修飾名	string (必須)

ARM テンプレート リソース定義

customApis リソースの種類は、次を対象とする操作でデプロイできます。

• リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Web/customApis リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Web/customApis",
  "apiVersion": "2016-06-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "etag": "string",
  "properties": {
    "apiDefinitions": {
      "modifiedSwaggerUrl": "string",
      "originalSwaggerUrl": "string"
    },
    "apiType": "string",
    "backendService": {
      "serviceUrl": "string"
    },
    "brandColor": "string",
    "capabilities": [ "string" ],
    "connectionParameters": {},
    "description": "string",
    "displayName": "string",
    "iconUri": "string",
    "runtimeUrls": [ "string" ],
    "swagger": {},
    "wsdlDefinition": {
      "content": "string",
      "importMethod": "string",
      "service": {
        "endpointQualifiedNames": [ "string" ],
        "qualifiedName": "string"
      },
      "url": "string",
      "content": "string",
      "importMethod": "string",
      "service": {
        "endpointQualifiedNames": [ "string" ],
        "qualifiedName": "string"
      },
      "url": "string"
    }
  }
}

プロパティ値

customApis

名前	説明	値
type	リソースの種類	'Microsoft.Web/customApis'
apiVersion	リソース API のバージョン	'2016-06-01'
name	リソース名	string (必須)
location	リソースの場所	string
tags	リソース タグ	タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
etag	リソース ETag	string
properties	カスタム API のプロパティ	CustomApiPropertiesDefinition

CustomApiPropertiesDefinition

名前	説明	値
apiDefinitions	API 定義	ApiResourceDefinitions
apiType	API の種類	'NotSpecified' 'Rest' 'Soap'
backendService	API バックエンド サービス	ApiResourceBackendService
brandColor	ブランドの色	string
capabilities	カスタム API 機能	string[]
connectionParameters	接続パラメーター	object
description	カスタム API の説明	string
displayName	表示名	string
iconUri	アイコン URI	string
runtimeUrls	ランタイム URL	string[]
Swagger	swagger の JSON 表現
wsdlDefinition	WSDL 定義	WsdlDefinition

ApiResourceDefinitions

名前	説明	値
modifiedSwaggerUrl	変更された Swagger URL	string
originalSwaggerUrl	元の Swagger URL	string

ApiResourceBackendService

名前	説明	値
serviceUrl	サービス URL	string

WsdlDefinition

名前	説明	値
content	WSDL コンテンツ	string
importMethod	WSDL インポート メソッド	'NotSpecified' 'SoapPassThrough' 'SoapToRest'
サービス (service)	名前とエンドポイント名を持つサービス	WsdlService
url	The WSDL URL	string
コンテンツ	WSDL コンテンツ	string
importMethod	WSDL インポート メソッド	'NotSpecified' 'SoapPassThrough' 'SoapToRest'
サービス (service)	名前とエンドポイント名を持つサービス	WsdlService
url	The WSDL URL	string

WsdlService

名前	説明	値
endpointQualifiedNames	エンドポイントの修飾名の一覧	string[]
qualifiedName	サービスの修飾名	string (必須)

Terraform (AzAPI プロバイダー) リソース定義

customApis リソースの種類は、次を対象とする操作でデプロイできます。

• リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Web/customApis リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/customApis@2016-06-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      apiDefinitions = {
        modifiedSwaggerUrl = "string"
        originalSwaggerUrl = "string"
      }
      apiType = "string"
      backendService = {
        serviceUrl = "string"
      }
      brandColor = "string"
      capabilities = [
        "string"
      ]
      connectionParameters = {}
      description = "string"
      displayName = "string"
      iconUri = "string"
      runtimeUrls = [
        "string"
      ]
      wsdlDefinition = {
        content = "string"
        importMethod = "string"
        service = {
          endpointQualifiedNames = [
            "string"
          ]
          qualifiedName = "string"
        }
        url = "string"
        content = "string"
        importMethod = "string"
        service = {
          endpointQualifiedNames = [
            "string"
          ]
          qualifiedName = "string"
        }
        url = "string"
      }
    }
    etag = "string"
  })
}

プロパティ値

customApis

名前	説明	値
type	リソースの種類	"Microsoft.Web/customApis@2016-06-01"
name	リソース名	string (必須)
location	リソースの場所	string
parent_id	リソース グループにデプロイするには、そのリソース グループの ID を使用します。	string (必須)
tags	リソース タグ	タグ名と値のディクショナリ。
etag	リソース ETag	string
properties	カスタム API のプロパティ	CustomApiPropertiesDefinition

CustomApiPropertiesDefinition

名前	説明	値
apiDefinitions	API 定義	ApiResourceDefinitions
apiType	API の種類	"NotSpecified" "Rest" "Soap"
backendService	API バックエンド サービス	ApiResourceBackendService
brandColor	ブランドの色	string
capabilities	カスタム API 機能	string[]
connectionParameters	接続パラメーター	object
description	カスタム API の説明	string
displayName	表示名	string
iconUri	アイコン URI	string
runtimeUrls	ランタイム URL	string[]
Swagger	swagger の JSON 表現
wsdlDefinition	WSDL 定義	WsdlDefinition

ApiResourceDefinitions

名前	説明	値
modifiedSwaggerUrl	変更された swagger URL	string
originalSwaggerUrl	元の swagger URL	string

ApiResourceBackendService

名前	説明	値
serviceUrl	サービス URL	string

WsdlDefinition

名前	説明	値
content	WSDL コンテンツ	string
importMethod	WSDL インポート メソッド	"NotSpecified" "SoapPassThrough" "SoapToRest"
サービス (service)	名前とエンドポイント名を持つサービス	WsdlService
url	The WSDL URL	string
コンテンツ	WSDL コンテンツ	string
importMethod	WSDL インポート メソッド	"NotSpecified" "SoapPassThrough" "SoapToRest"
サービス (service)	名前とエンドポイント名を持つサービス	WsdlService
url	The WSDL URL	string

WsdlService

名前	説明	値
endpointQualifiedNames	エンドポイントの修飾名の一覧	string[]
qualifiedName	サービスの修飾名	string (必須)