さくらのクラウド さくらのクラウド API ポータル クラウドマニュアルへ
API docs by Redocly

Add-on APIドキュメント (1.1.1)

Download OpenAPI specification:Download OpenAPI Spec (YAML)Download OpenAPI Spec (JSON)

License: Copyright(C) SAKURA internet Inc. all rights reserved.

「Add-on」が提供するAPIの利用方法とサンプルを公開しております。

基本的な使い方

APIキーの発行

APIを利用するためには、認証のための「APIキー」が必要です。事前にキーを発行しておきます。
APIキーは「ユーザーID」「パスワード」に相当する「トークン」と呼ばれる認証情報で構成されています。

項目名 APIキー発行時の項目名 このドキュメント内での例
ユーザーID アクセストークン(UUID) 01234567-89ab-cdef-0123-456789abcdef
パスワード アクセストークンシークレット SAMPLETOKENSAMPLETOKENSAMPLETOKENSAM
操作マニュアル

AI

AI機能リソースの一覧を取得します。

アドオンのAI機能リソースの一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ]
}

AI機能リソースを作成します。

アドオンのAI機能リソースを作成します。

Request Body schema: application/json
required
location
required
string non-empty
Value: "japaneast"

デプロイ先のリージョン

sku
required
integer <int32> (AiServiceSku)
Value: 1

AI Servicesリソースで使用するSKUを指定します。指定値とSKUの対応は次の通りです。

  • 1: S0

Responses

Request samples

Content type
application/json
{
  • "location": "japaneast",
  • "sku": 1
}

Response samples

Content type
application/json
{
  • "resourceGroupName": "string",
  • "deploymentName": "string"
}

指定されたAI機能リソースを取得します。

アドオンの指定されたAI機能リソースを取得します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "data": null,
  • "url": "string"
}

指定されたAI機能リソースを削除します。

アドオンの指定されたAI機能リソースを削除します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

指定されたAI機能リソースのステータスを取得します。

アドオンの指定されたAI機能リソースのステータスを取得します。

path Parameters
resourceGroupName
required
string
deploymentName
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "properties": {
    }
}

CDN

CDNサービスリソースの一覧を取得します。

アドオンのCDNサービスリソースの一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ]
}

CDNサービスリソースを作成します。

アドオンのCDNサービスリソースを作成します。

Request Body schema: application/json
required
location
required
string non-empty
Value: "japaneast"

デプロイ先のリージョン

required
object (FrontDoorProfile)

Front Doorのプロファイル

required
object (FrontDoorEndpoint)

Front Doorのエンドポイント

Responses

Request samples

Content type
application/json
{
  • "location": "japaneast",
  • "profile": {
    },
  • "endpoint": {
    }
}

Response samples

Content type
application/json
{
  • "resourceGroupName": "string",
  • "deploymentName": "string"
}

指定されたCDNサービスリソースを取得します。

アドオンの指定されたCDNサービスリソースを取得します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "data": null,
  • "url": "string"
}

指定されたCDNサービスリソースを削除します。

アドオンの指定されたCDNサービスリソースを削除します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

指定されたCDNサービスリソースのステータスを取得します。

アドオンの指定されたCDNサービスリソースのステータスを取得します。

path Parameters
resourceGroupName
required
string

リソースグループ名

deploymentName
required
string

デプロイメント名

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "properties": {
    }
}

セキュリティ

DDoS対策サービスリソースの一覧を取得します。

アドオンのDDoS対策サービスリソースの一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ]
}

DDoS対策サービスリソースを作成します。

アドオンのDDoS対策サービスリソースを作成します。

Request Body schema: application/json
required
location
required
string non-empty
Value: "japaneast"

デプロイ先のリージョン

required
object (FrontDoorProfile)

Front Doorのプロファイル

required
object (FrontDoorEndpoint)

Front Doorのエンドポイント

Responses

Request samples

Content type
application/json
{
  • "location": "japaneast",
  • "profile": {
    },
  • "endpoint": {
    }
}

Response samples

Content type
application/json
{
  • "resourceGroupName": "string",
  • "deploymentName": "string"
}

指定されたDDoS対策サービスリソースを取得します。

アドオンの指定されたDDoS対策サービスリソースを取得します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "data": null,
  • "url": "string"
}

指定されたDDoS対策サービスリソースを削除します。

アドオンの指定されたDDoS対策サービスリソースを削除します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

指定されたDDoS対策サービスリソースのステータスを取得します。

アドオンの指定されたDDoS対策サービスリソースのステータスを取得します。

path Parameters
resourceGroupName
required
string

リソースグループ名

deploymentName
required
string

デプロイメント名

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "properties": {
    }
}

WAFサービスリソースの一覧を取得します。

アドオンのWAFサービスリソースの一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ]
}

WAFサービスリソースを作成します。

アドオンのWAFサービスリソースを作成します。

Request Body schema: application/json
required
location
required
string non-empty
Value: "japaneast"

デプロイ先のリージョン

required
object (FrontDoorProfile)

Front Doorのプロファイル

required
object (FrontDoorEndpoint)

Front Doorのエンドポイント

Responses

Request samples

Content type
application/json
{
  • "location": "japaneast",
  • "profile": {
    },
  • "endpoint": {
    }
}

Response samples

Content type
application/json
{
  • "resourceGroupName": "string",
  • "deploymentName": "string"
}

指定されたWAFサービスリソースを取得します。

アドオンの指定されたWAFサービスリソースを取得します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "data": null,
  • "url": "string"
}

指定されたWAFサービスリソースを削除します。

アドオンの指定されたWAFサービスリソースを削除します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

指定されたWAFサービスリソースのステータスを取得します。

アドオンの指定されたWAFサービスリソースのステータスを取得します。

path Parameters
resourceGroupName
required
string

リソースグループ名

deploymentName
required
string

デプロイメント名

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "properties": {
    }
}

脆弱性検出サービスリソースの一覧を取得します。

アドオンの脆弱性検出サービスリソースの一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ]
}

脆弱性検出サービスのインストールスクリプトを発行します。

アドオンの脆弱性検出サービスリソースを作成します。脆弱性検出サービスを利用するためには、レスポンスに含まれるインストールスクリプトを対象のVMで実行しエージェントをインストールする必要があります。

Request Body schema: application/json
required
location
required
string non-empty
Value: "japaneast"

デプロイ先のリージョン

os
required
integer <int32> (ServerOsType)
Enum: 1 2

サーバーのOSの種類を指定します。指定値とOSの種類の対応は次の通りです。

  • 1: Windows
  • 2: Linux

Responses

Request samples

Content type
application/json
{
  • "location": "japaneast",
  • "os": 1
}

Response samples

Content type
application/json
{
  • "resourceGroupName": "string",
  • "installScript": "string"
}

指定された脆弱性検出サービスリソースを取得します。

アドオンの指定された脆弱性検出サービスリソースを取得します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "data": null,
  • "url": "string"
}

指定された脆弱性検出サービスリソースを削除します。

アドオンの指定された脆弱性検出サービスリソースを削除します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

データ分析

データレイクリソースの一覧を取得します。

アドオンのデータレイクリソースの一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ]
}

データレイクリソースを作成します。

アドオンのデータレイクリソースを作成します。

Request Body schema: application/json
required
location
required
string non-empty
Value: "japaneast"

デプロイ先のリージョン

performance
required
integer <int32> (DataLakePerformance)
Enum: 1 2

パフォーマンスを指定します。指定値とパフォーマンスの対応は次の通りです。

  • 1: Standard
  • 2: Premium
redundancy
required
integer <int32> (DataLakeRedundancy)
Enum: 1 2 3 4

冗長性を指定します。指定値と冗長性の対応は次の通りです。

  • 1: LRS（ローカル冗長ストレージ）
  • 2: GRS（geo冗長ストレージ）
  • 3: ZRS（ゾーン冗長ストレージ）
  • 4: GZRS（geoゾーン冗長ストレージ）

Responses

Request samples

Content type
application/json
{
  • "location": "japaneast",
  • "performance": 1,
  • "redundancy": 1
}

Response samples

Content type
application/json
{
  • "resourceGroupName": "string",
  • "deploymentName": "string"
}

指定されたデータレイクリソースを取得します。

アドオンの指定されたデータレイクリソースを取得します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "data": null,
  • "url": "string"
}

指定されたデータレイクリソースを削除します。

アドオンの指定されたデータレイクリソースを削除します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

指定されたデータレイクリソースのステータスを取得します。

アドオンの指定されたデータレイクリソースのステータスを取得します。

path Parameters
resourceGroupName
required
string
deploymentName
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "properties": {
    }
}

データウェアハウスリソースの一覧を取得します。

アドオンのデータウェアハウスリソースの一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ]
}

データウェアハウスリソースを作成します。

アドオンのデータウェアハウスリソースを作成します。

Request Body schema: application/json
required
location
required
string non-empty
Value: "japaneast"

デプロイ先のリージョン

Responses

Request samples

Content type
application/json
{
  • "location": "japaneast"
}

Response samples

Content type
application/json
{
  • "resourceGroupName": "string",
  • "deploymentName": "string"
}

指定されたデータウェアハウスリソースを取得します。

アドオンの指定されたデータウェアハウスリソースを取得します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "data": null,
  • "url": "string"
}

指定されたデータウェアハウスリソースを削除します。

アドオンの指定されたデータウェアハウスリソースを削除します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

指定されたデータウェアハウスリソースのステータスを取得します。

アドオンの指定されたデータウェアハウスリソースのステータスを取得します。

path Parameters
resourceGroupName
required
string
deploymentName
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "properties": {
    }
}

データETLリソースの一覧を取得します。

アドオンのデータETLリソースの一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ]
}

データETLリソースを作成します。

アドオンのデータETLリソースを作成します。

Request Body schema: application/json
required
location
required
string non-empty
Value: "japaneast"

デプロイ先のリージョン

Responses

Request samples

Content type
application/json
{
  • "location": "japaneast"
}

Response samples

Content type
application/json
{
  • "resourceGroupName": "string",
  • "deploymentName": "string"
}

指定されたデータETLリソースを削除します。

アドオンの指定されたデータETLリソースを削除します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

指定されたデータETLリソースを取得します。

アドオンの指定されたデータETLリソースを取得します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "data": null,
  • "url": "string"
}

指定されたデータETLリソースのステータスを取得します。

アドオンの指定されたデータETLリソースのステータスを取得します。

path Parameters
resourceGroupName
required
string
deploymentName
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "properties": {
    }
}

クエリ機能リソースの一覧を取得します。

アドオンのクエリ機能リソースの一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ]
}

クエリ機能リソースを作成します。

アドオンのクエリ機能リソースを作成します。

Request Body schema: application/json
required
location
required
string non-empty
Value: "japaneast"

デプロイ先のリージョン

Responses

Request samples

Content type
application/json
{
  • "location": "japaneast"
}

Response samples

Content type
application/json
{
  • "resourceGroupName": "string",
  • "deploymentName": "string"
}

指定されたクエリ機能リソースを取得します。

アドオンの指定されたクエリ機能リソースを取得します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "data": null,
  • "url": "string"
}

指定されたクエリ機能リソースを削除します。

アドオンの指定されたクエリ機能リソースを削除します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

指定されたクエリ機能リソースのステータスを取得します。

アドオンの指定されたクエリ機能リソースのステータスを取得します。

path Parameters
resourceGroupName
required
string
deploymentName
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "properties": {
    }
}

検索機能リソースの一覧を取得します。

アドオンの検索機能リソースの一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ]
}

検索機能リソースを作成します。

アドオンの検索機能リソースを作成します。

Request Body schema: application/json
required
location
required
string non-empty
Value: "japaneast"

デプロイ先のリージョン

sku
required
integer <int32> (SearchSku)
Enum: 1 2 3 4 5 6 7 8

AI SearchのSKUを指定します。 指定値とSKUの対応は次の通りです。

  • 1: Free
  • 2: Basic
  • 3: Standard
  • 4: Standard2
  • 5: Standard3
  • 6: Standard3HD
  • 7: StorageOptimizedL1
  • 8: StorageOptimizedL2
replicaCount
required
integer <int32> [ 1 .. 12 ]

AI Searchのレプリカ数を指定します。 選択したSKUに応じて、指定可能な値は次の通りです。

  • 1: 全SKUで指定可能
  • 2, 3: Free 以外のSKUで指定可能
  • 4 ～ 12: Free、Basic 以外のSKUで指定可能
partitionCount
required
integer <int32>
Enum: "1" "2" "3" "4" "6" "12"

AI Searchのパーティション数を指定します。 指定できる値は 1, 2, 3, 4, 6, 12 のいずれかです。 選択したSKUに応じて、指定可能な値は次の通りです。

  • 1: 全SKUで指定可能
  • 2, 3: Free 以外のSKUで指定可能
  • 4, 6, 12: Free、Basic、Standard3HD 以外のSKUで指定可能

また、レプリカ数 × パーティション数は次の範囲にしてください。

  • 1: SKUにFreeを指定する場合
  • 1 ～ 9: SKUにBasicを指定する場合
  • 1 ～ 36: Free、Basic 以外のSKUを指定する場合

Responses

Request samples

Content type
application/json
{
  • "location": "japaneast",
  • "sku": 1,
  • "replicaCount": 1,
  • "partitionCount": "1"
}

Response samples

Content type
application/json
{
  • "resourceGroupName": "string",
  • "deploymentName": "string"
}

指定された検索機能リソースを取得します。

アドオンの指定された検索機能リソースを取得します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "data": null,
  • "url": "string"
}

指定された検索機能リソースを削除します。

アドオンの指定された検索機能リソースを削除します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

指定された検索機能リソースのステータスを取得します。

アドオンの指定された検索機能リソースのステータスを取得します。

path Parameters
resourceGroupName
required
string
deploymentName
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "properties": {
    }
}

ストリーミング処理機能リソースの一覧を取得します。

アドオンのストリーミング処理機能リソースの一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ]
}

ストリーミング処理機能リソースを作成します。

アドオンのストリーミング処理機能リソースを作成します。

Request Body schema: application/json
required
location
required
string non-empty
Value: "japaneast"

デプロイ先のリージョン

unitCount
required
string non-empty

Stream Analyticsのストリーミングユニット数を指定します。 指定値と実際のユニット数の対応は次の通りです。

  • 3: 1/3ユニット
  • 7: 2/3ユニット
  • 10 ～ 660: 1 ～ 66ユニット（※）

※ 10 以上を指定する場合は、作成したいユニット数 × 10 の値を指定してください。指定できるのは 10 の倍数のみです。11 など 10 の倍数でない値を指定した場合はエラーとなります。

Responses

Request samples

Content type
application/json
{
  • "location": "japaneast",
  • "unitCount": "string"
}

Response samples

Content type
application/json
{
  • "resourceGroupName": "string",
  • "deploymentName": "string"
}

指定されたストリーミング処理機能リソースを取得します。

アドオンの指定されたストリーミング処理機能リソースを取得します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "data": null,
  • "url": "string"
}

指定されたストリーミング処理機能リソースを削除します。

アドオンの指定されたストリーミング処理機能リソースを削除します。

path Parameters
resourceGroupName
required
string

リソースグループ名

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

指定されたストリーミング処理機能リソースのステータスを取得します。

アドオンの指定されたストリーミング処理機能リソースのステータスを取得します。

path Parameters
resourceGroupName
required
string
deploymentName
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "properties": {
    }
}