Watchlists interface
ウォッチリストを表すインターフェイス。
メソッド
| create |
ウォッチリストとそのウォッチリスト アイテムを作成または更新します (テキスト/csv コンテンツ タイプを使用した一括作成など)。 ウォッチリストとそのアイテムを作成するには、rawContent または有効な SAR URI と contentType プロパティを使用してこのエンドポイントを呼び出す必要があります。 rawContent は主に小さなウォッチリスト (3.8 MB 未満のコンテンツ サイズ) に使用されます。 SAS URI を使用すると、コンテンツ サイズが最大 500 MB の大規模なウォッチリストを作成できます。 このような大きなファイルの処理の状態は、Azure-AsyncOperation ヘッダーで返される URL を介してポーリングできます。 |
| delete(string, string, string, Watchlists |
ウォッチリストを削除します。 |
| get(string, string, string, Watchlists |
ウォッチリスト項目を含まないウォッチリストを取得します。 |
| list(string, string, Watchlists |
ウォッチリスト項目を含まないすべてのウォッチリストを取得します。 |
メソッドの詳細
createOrUpdate(string, string, string, Watchlist, WatchlistsCreateOrUpdateOptionalParams)
ウォッチリストとそのウォッチリスト アイテムを作成または更新します (テキスト/csv コンテンツ タイプを使用した一括作成など)。 ウォッチリストとそのアイテムを作成するには、rawContent または有効な SAR URI と contentType プロパティを使用してこのエンドポイントを呼び出す必要があります。 rawContent は主に小さなウォッチリスト (3.8 MB 未満のコンテンツ サイズ) に使用されます。 SAS URI を使用すると、コンテンツ サイズが最大 500 MB の大規模なウォッチリストを作成できます。 このような大きなファイルの処理の状態は、Azure-AsyncOperation ヘッダーで返される URL を介してポーリングできます。
function createOrUpdate(resourceGroupName: string, workspaceName: string, watchlistAlias: string, watchlist: Watchlist, options?: WatchlistsCreateOrUpdateOptionalParams): Promise<Watchlist>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前は大文字と小文字が区別されます。
- workspaceName
-
string
ワークスペースの名前。
- watchlistAlias
-
string
ウォッチリストエイリアス
- watchlist
- Watchlist
ウォッチリスト
オプション パラメーター。
戻り値
Promise<Watchlist>
delete(string, string, string, WatchlistsDeleteOptionalParams)
ウォッチリストを削除します。
function delete(resourceGroupName: string, workspaceName: string, watchlistAlias: string, options?: WatchlistsDeleteOptionalParams): Promise<WatchlistsDeleteHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前は大文字と小文字が区別されます。
- workspaceName
-
string
ワークスペースの名前。
- watchlistAlias
-
string
ウォッチリストエイリアス
- options
- WatchlistsDeleteOptionalParams
オプション パラメーター。
戻り値
Promise<WatchlistsDeleteHeaders>
get(string, string, string, WatchlistsGetOptionalParams)
ウォッチリスト項目を含まないウォッチリストを取得します。
function get(resourceGroupName: string, workspaceName: string, watchlistAlias: string, options?: WatchlistsGetOptionalParams): Promise<Watchlist>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前は大文字と小文字が区別されます。
- workspaceName
-
string
ワークスペースの名前。
- watchlistAlias
-
string
ウォッチリストエイリアス
- options
- WatchlistsGetOptionalParams
オプション パラメーター。
戻り値
Promise<Watchlist>
list(string, string, WatchlistsListOptionalParams)
ウォッチリスト項目を含まないすべてのウォッチリストを取得します。
function list(resourceGroupName: string, workspaceName: string, options?: WatchlistsListOptionalParams): PagedAsyncIterableIterator<Watchlist, Watchlist[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前は大文字と小文字が区別されます。
- workspaceName
-
string
ワークスペースの名前。
- options
- WatchlistsListOptionalParams
オプション パラメーター。
