Microsoft.Web customApis 2016-06-01

2025-06-26

最新のをする
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(...)
              uiDefinition: any(...)
              value: 'string'
            }
          }
          identityProvider: 'string'
          properties: any(...)
          redirectUrl: 'string'
          scopes: [
            'string'
          ]
        }
        type: 'string'
      }
    }
    description: 'string'
    displayName: 'string'
    iconUri: 'string'
    runtimeUrls: [
      'string'
    ]
    swagger: any(...)
    wsdlDefinition: {
      content: 'string'
      importMethod: 'string'
      service: {
        endpointQualifiedNames: [
          'string'
        ]
        qualifiedName: 'string'
      }
      url: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

マイクロソフト.ウェブ/customApis

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

ApiOAuth設定

名前	説明	価値
クライアントID	リソースプロバイダーのクライアント ID	糸
クライアントシークレット	OAuth に必要なクライアントシークレット	糸
カスタムパラメータ	OAuth パラメーターキーはパラメーターの名前です	ApiOAuthSettingsCustomParameters
アイデンティティプロバイダ	ID プロバイダー	糸
プロパティ	この oauth 設定のプロパティを読み取り専用にします。	任意
リダイレクトURL	URL	糸
スコープ	OAuth スコープ	文字列[]

ApiOAuthSettingsCustomParameters

名前	説明	価値

ApiOAuthSettingsパラメータ

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

ApiResourceBackendサービス

名前	説明	価値
サービスURL	サービス URL	糸

ApiResourceDefinitions (英語)

名前	説明	価値
modifiedSwaggerUrl (英語)	変更された swagger URL	糸
オリジナルSwaggerのURL	元の swagger URL	糸

コネクションパラメータ

名前	説明	価値
oAuthSettings	接続プロバイダーの OAuth 設定	ApiOAuth設定
種類	パラメーターの型	'配列' ブール '接続' 'int' 'oauthSetting' 'オブジェクト' 'セキュアオブジェクト' 'セキュアストリング' 文字列

CustomApiPropertiesDefinition

名前	説明	価値
apiDefinitionsの	API 定義	ApiResourceDefinitions (英語)
apiタイプ(apiType)	API の種類	'指定されていません' 「休息」「ソープ」
バックエンドサービス	API バックエンドサービス	ApiResourceBackendService の
ブランドカラー	ブランドの色	糸
能力	カスタム API 機能	文字列[]
connectionParameters (接続パラメータ)	接続パラメーター	CustomApiPropertiesDefinitionConnectionParameters の
説明	カスタム API の説明	糸
ディスプレイ名	表示名	糸
アイコンUri	アイコン URI	糸
ランタイムURL	ランタイム URL	文字列[]
Swagger	swagger の JSON 表現	任意
wsdl定義	WSDL 定義	WsdlDefinition の

CustomApiPropertiesDefinition接続パラメータ

名前	説明	価値

タグ辞書

名前	説明	価値

Wsdlの定義

名前	説明	価値
コンテンツ	WSDL コンテンツ	糸
インポートメソッド	WSDL インポートメソッド	'指定されていません' 「ソープパススルー」「ソープ・トゥ・レスト」
サービス (service)	名前とエンドポイント名を持つサービス	WsdlService の
URL	WSDL の URL	糸

Wsdlサービス

名前	説明	価値
エンドポイント修飾名	エンドポイントの修飾名の一覧	文字列[]
修飾名	サービスの修飾名	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"
  }
}

プロパティ値

マイクロソフト.ウェブ/customApis

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

ApiOAuth設定

名前	説明	価値
クライアントID	リソースプロバイダーのクライアント ID	糸
クライアントシークレット	OAuth に必要なクライアントシークレット	糸
カスタムパラメータ	OAuth パラメーターキーはパラメーターの名前です	ApiOAuthSettingsCustomParameters
アイデンティティプロバイダ	ID プロバイダー	糸
プロパティ	この oauth 設定のプロパティを読み取り専用にします。	任意
リダイレクトURL	URL	糸
スコープ	OAuth スコープ	文字列[]

ApiOAuthSettingsCustomParameters

名前	説明	価値

ApiOAuthSettingsパラメータ

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

ApiResourceBackendサービス

名前	説明	価値
サービスURL	サービス URL	糸

ApiResourceDefinitions (英語)

名前	説明	価値
modifiedSwaggerUrl (英語)	変更された swagger URL	糸
オリジナルSwaggerのURL	元の swagger URL	糸

コネクションパラメータ

名前	説明	価値
oAuthSettings	接続プロバイダーの OAuth 設定	ApiOAuth設定
種類	パラメーターの型	'配列' ブール '接続' 'int' 'oauthSetting' 'オブジェクト' 'セキュアオブジェクト' 'セキュアストリング' 文字列

CustomApiPropertiesDefinition

名前	説明	価値
apiDefinitionsの	API 定義	ApiResourceDefinitions (英語)
apiタイプ(apiType)	API の種類	'指定されていません' 「休息」「ソープ」
バックエンドサービス	API バックエンドサービス	ApiResourceBackendService の
ブランドカラー	ブランドの色	糸
能力	カスタム API 機能	文字列[]
connectionParameters (接続パラメータ)	接続パラメーター	CustomApiPropertiesDefinitionConnectionParameters の
説明	カスタム API の説明	糸
ディスプレイ名	表示名	糸
アイコンUri	アイコン URI	糸
ランタイムURL	ランタイム URL	文字列[]
Swagger	swagger の JSON 表現	任意
wsdl定義	WSDL 定義	WsdlDefinition の

CustomApiPropertiesDefinition接続パラメータ

名前	説明	価値

タグ辞書

名前	説明	価値

Wsdlの定義

名前	説明	価値
コンテンツ	WSDL コンテンツ	糸
インポートメソッド	WSDL インポートメソッド	'指定されていません' 「ソープパススルー」「ソープ・トゥ・レスト」
サービス (service)	名前とエンドポイント名を持つサービス	WsdlService の
URL	WSDL の URL	糸

Wsdlサービス

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

使用例

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

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

リソースグループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/customApis@2016-06-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    etag = "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"
      }
    }
  }
}

プロパティ値

マイクロソフト.ウェブ/customApis

名前	説明	価値
ETAGの	リソース ETag	糸
ロケーション	リソースの場所	糸
名前	リソース名	string (必須)
プロパティ	カスタム API プロパティ	CustomApiPropertiesDefinition の
タグ	リソースタグ	タグ名と値のディクショナリ。
種類	リソースの種類	"マイクロソフト.Web/customApis@2016-06-01"

ApiOAuth設定

名前	説明	価値
クライアントID	リソースプロバイダーのクライアント ID	糸
クライアントシークレット	OAuth に必要なクライアントシークレット	糸
カスタムパラメータ	OAuth パラメーターキーはパラメーターの名前です	ApiOAuthSettingsCustomParameters
アイデンティティプロバイダ	ID プロバイダー	糸
プロパティ	この oauth 設定のプロパティを読み取り専用にします。	任意
リダイレクトURL	URL	糸
スコープ	OAuth スコープ	文字列[]

ApiOAuthSettingsCustomParameters

名前	説明	価値

ApiOAuthSettingsパラメータ

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

ApiResourceBackendサービス

名前	説明	価値
サービスURL	サービス URL	糸

ApiResourceDefinitions (英語)

名前	説明	価値
modifiedSwaggerUrl (英語)	変更された swagger URL	糸
オリジナルSwaggerのURL	元の swagger URL	糸

コネクションパラメータ

名前	説明	価値
oAuthSettings	接続プロバイダーの OAuth 設定	ApiOAuth設定
種類	パラメーターの型	'配列' ブール '接続' 'int' 'oauthSetting' 'オブジェクト' 'セキュアオブジェクト' 'セキュアストリング' 文字列

CustomApiPropertiesDefinition

名前	説明	価値
apiDefinitionsの	API 定義	ApiResourceDefinitions (英語)
apiタイプ(apiType)	API の種類	'指定されていません' 「休息」「ソープ」
バックエンドサービス	API バックエンドサービス	ApiResourceBackendService の
ブランドカラー	ブランドの色	糸
能力	カスタム API 機能	文字列[]
connectionParameters (接続パラメータ)	接続パラメーター	CustomApiPropertiesDefinitionConnectionParameters の
説明	カスタム API の説明	糸
ディスプレイ名	表示名	糸
アイコンUri	アイコン URI	糸
ランタイムURL	ランタイム URL	文字列[]
Swagger	swagger の JSON 表現	任意
wsdl定義	WSDL 定義	WsdlDefinition の

CustomApiPropertiesDefinition接続パラメータ

名前	説明	価値

タグ辞書

名前	説明	価値

Wsdlの定義

名前	説明	価値
コンテンツ	WSDL コンテンツ	糸
インポートメソッド	WSDL インポートメソッド	'指定されていません' 「ソープパススルー」「ソープ・トゥ・レスト」
サービス (service)	名前とエンドポイント名を持つサービス	WsdlService の
URL	WSDL の URL	糸

Wsdlサービス

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

次の方法で共有

Microsoft.Web customApis 2016-06-01

Bicep リソース定義

リソースの形式

プロパティ値

マイクロソフト.ウェブ/customApis

ApiOAuth設定

ApiOAuthSettingsCustomParameters

ApiOAuthSettingsパラメータ

ApiResourceBackendサービス

ApiResourceDefinitions (英語)

コネクションパラメータ

CustomApiPropertiesDefinition

CustomApiPropertiesDefinition接続パラメータ

タグ辞書

Wsdlの定義

Wsdlサービス

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

リソースの形式

プロパティ値

マイクロソフト.ウェブ/customApis

ApiOAuth設定

ApiOAuthSettingsCustomParameters

ApiOAuthSettingsパラメータ

ApiResourceBackendサービス

ApiResourceDefinitions (英語)

コネクションパラメータ

CustomApiPropertiesDefinition

CustomApiPropertiesDefinition接続パラメータ

タグ辞書

Wsdlの定義

Wsdlサービス

使用例

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

リソースの形式

プロパティ値

マイクロソフト.ウェブ/customApis

ApiOAuth設定

ApiOAuthSettingsCustomParameters

ApiOAuthSettingsパラメータ

ApiResourceBackendサービス

ApiResourceDefinitions (英語)

コネクションパラメータ

CustomApiPropertiesDefinition

CustomApiPropertiesDefinition接続パラメータ

タグ辞書

Wsdlの定義

Wsdlサービス

フィードバック

その他のリソース

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