Microsoft.Web customApis

[アーティクル]
12/09/2024

最新のをする
2016-06-01

Bicep リソース定義

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

リソースグループの - リソースグループのデプロイコマンド参照

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

リソースの形式

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

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'
  }
}

プロパティ値

ApiOAuthSettings

名前	形容	価値
clientId	リソースプロバイダーのクライアント ID	糸
clientSecret	OAuth に必要なクライアントシークレット	糸
customParameters	OAuth パラメーターキーはパラメーターの名前です	ApiOAuthSettingsCustomParameters
identityProvider	ID プロバイダー	糸
プロパティ	この oauth 設定のプロパティを読み取り専用にします。	任意
redirectUrl	URL	糸
スコープ	OAuth スコープ	string[]

ApiOAuthSettingsCustomParameters

名前	形容	価値

ApiOAuthSettingsParameter

名前	形容	価値
オプション	このパラメーターで使用できるオプション	任意
uiDefinition	呼び出し元がカルチャを指定できるカルチャごとの UI 定義	任意
価値	設定の値	糸

ApiResourceBackendService

名前	形容	価値
serviceUrl	サービス URL	糸

ApiResourceDefinitions

名前	形容	価値
modifiedSwaggerUrl	変更された swagger URL	糸
originalSwaggerUrl	元の swagger URL	糸

ConnectionParameter

名前	形容	価値
oAuthSettings	接続プロバイダーの OAuth 設定	ApiOAuthSettings
種類	パラメーターの型	'array' 'bool' 'connection' 'int' 'oauthSetting' 'object' 'secureobject' 'securestring' 'string'

CustomApiPropertiesDefinition

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

CustomApiPropertiesDefinitionConnectionParameters

名前	形容	価値

Microsoft.Web/customApis

名前	形容	価値
etag	リソース ETag	糸
場所	リソースの場所	糸
名前	リソース名	string (必須)
プロパティ	カスタム API プロパティ	CustomApiPropertiesDefinition の
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください

TagsDictionary

名前	形容	価値

WsdlDefinition

名前	形容	価値
コンテンツ	WSDL コンテンツ	糸
importMethod	WSDL インポートメソッド	'NotSpecified' 'SoapPassThrough' 'SoapToRest'
サービス	名前とエンドポイント名を持つサービス	WsdlService の
url	The WSDL URL	糸

WsdlService

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

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

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

リソースグループの - リソースグループのデプロイコマンド参照

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

リソースの形式

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

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

プロパティ値

ApiOAuthSettings

名前	形容	価値
clientId	リソースプロバイダーのクライアント ID	糸
clientSecret	OAuth に必要なクライアントシークレット	糸
customParameters	OAuth パラメーターキーはパラメーターの名前です	ApiOAuthSettingsCustomParameters
identityProvider	ID プロバイダー	糸
プロパティ	この oauth 設定のプロパティを読み取り専用にします。	任意
redirectUrl	URL	糸
スコープ	OAuth スコープ	string[]

ApiOAuthSettingsCustomParameters

名前	形容	価値

ApiOAuthSettingsParameter

名前	形容	価値
オプション	このパラメーターで使用できるオプション	任意
uiDefinition	呼び出し元がカルチャを指定できるカルチャごとの UI 定義	任意
価値	設定の値	糸

ApiResourceBackendService

名前	形容	価値
serviceUrl	サービス URL	糸

ApiResourceDefinitions

名前	形容	価値
modifiedSwaggerUrl	変更された swagger URL	糸
originalSwaggerUrl	元の swagger URL	糸

ConnectionParameter

名前	形容	価値
oAuthSettings	接続プロバイダーの OAuth 設定	ApiOAuthSettings
種類	パラメーターの型	'array' 'bool' 'connection' 'int' 'oauthSetting' 'object' 'secureobject' 'securestring' 'string'

CustomApiPropertiesDefinition

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

CustomApiPropertiesDefinitionConnectionParameters

名前	形容	価値

Microsoft.Web/customApis

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

TagsDictionary

名前	形容	価値

WsdlDefinition

名前	形容	価値
コンテンツ	WSDL コンテンツ	糸
importMethod	WSDL インポートメソッド	'NotSpecified' 'SoapPassThrough' 'SoapToRest'
サービス	名前とエンドポイント名を持つサービス	WsdlService の
url	The WSDL URL	糸

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"
  etag = "string"
  location = "string"
  tags = {
    {customized property} = "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"
      }
    }
  })
}

プロパティ値

ApiOAuthSettings

名前	形容	価値
clientId	リソースプロバイダーのクライアント ID	糸
clientSecret	OAuth に必要なクライアントシークレット	糸
customParameters	OAuth パラメーターキーはパラメーターの名前です	ApiOAuthSettingsCustomParameters
identityProvider	ID プロバイダー	糸
プロパティ	この oauth 設定のプロパティを読み取り専用にします。	任意
redirectUrl	URL	糸
スコープ	OAuth スコープ	string[]

ApiOAuthSettingsCustomParameters

名前	形容	価値

ApiOAuthSettingsParameter

名前	形容	価値
オプション	このパラメーターで使用できるオプション	任意
uiDefinition	呼び出し元がカルチャを指定できるカルチャごとの UI 定義	任意
価値	設定の値	糸

ApiResourceBackendService

名前	形容	価値
serviceUrl	サービス URL	糸

ApiResourceDefinitions

名前	形容	価値
modifiedSwaggerUrl	変更された swagger URL	糸
originalSwaggerUrl	元の swagger URL	糸

ConnectionParameter

名前	形容	価値
oAuthSettings	接続プロバイダーの OAuth 設定	ApiOAuthSettings
種類	パラメーターの型	'array' 'bool' 'connection' 'int' 'oauthSetting' 'object' 'secureobject' 'securestring' 'string'

CustomApiPropertiesDefinition

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

CustomApiPropertiesDefinitionConnectionParameters

名前	形容	価値

Microsoft.Web/customApis

名前	形容	価値
etag	リソース ETag	糸
場所	リソースの場所	糸
名前	リソース名	string (必須)
プロパティ	カスタム API プロパティ	CustomApiPropertiesDefinition の
タグ	リソースタグ	タグ名と値のディクショナリ。
種類	リソースの種類	"Microsoft.Web/customApis@2016-06-01"

TagsDictionary

名前	形容	価値

WsdlDefinition

名前	形容	価値
コンテンツ	WSDL コンテンツ	糸
importMethod	WSDL インポートメソッド	'NotSpecified' 'SoapPassThrough' 'SoapToRest'
サービス	名前とエンドポイント名を持つサービス	WsdlService の
url	The WSDL URL	糸

WsdlService

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

次の方法で共有

Microsoft.Web customApis

Bicep リソース定義

リソースの形式

プロパティ値

ApiOAuthSettings

ApiOAuthSettingsCustomParameters

ApiOAuthSettingsParameter

ApiResourceBackendService

ApiResourceDefinitions

ConnectionParameter

CustomApiPropertiesDefinition

CustomApiPropertiesDefinitionConnectionParameters

Microsoft.Web/customApis

TagsDictionary

WsdlDefinition

WsdlService

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

リソースの形式

プロパティ値

ApiOAuthSettings

ApiOAuthSettingsCustomParameters

ApiOAuthSettingsParameter

ApiResourceBackendService

ApiResourceDefinitions

ConnectionParameter

CustomApiPropertiesDefinition

CustomApiPropertiesDefinitionConnectionParameters

Microsoft.Web/customApis

TagsDictionary

WsdlDefinition

WsdlService

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

リソースの形式

プロパティ値

ApiOAuthSettings

ApiOAuthSettingsCustomParameters

ApiOAuthSettingsParameter

ApiResourceBackendService

ApiResourceDefinitions

ConnectionParameter

CustomApiPropertiesDefinition

CustomApiPropertiesDefinitionConnectionParameters

Microsoft.Web/customApis

TagsDictionary

WsdlDefinition

WsdlService

フィードバック

その他のリソース

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