Workbooks interface
ブックを表すインターフェイス。
メソッド
| create |
新しいブックを作成します。 |
| delete(string, string, Workbooks |
ブックを削除します。 |
| get(string, string, Workbooks |
resourceName で 1 つのブックを取得します。 |
| list |
指定したリソース グループとカテゴリ内で定義されているすべてのブックを取得します。 |
| list |
指定したサブスクリプションとカテゴリ内で定義されているすべてのブックを取得します。 |
| list |
resourceName で定義されたブックのリビジョンを取得します。 |
| revision |
revisionId によって定義された単一のブックリビジョンを取得します。 |
| update(string, string, Workbooks |
既に追加されているブックを更新します。 |
メソッドの詳細
createOrUpdate(string, string, Workbook, WorkbooksCreateOrUpdateOptionalParams)
新しいブックを作成します。
function createOrUpdate(resourceGroupName: string, resourceName: string, workbookProperties: Workbook, options?: WorkbooksCreateOrUpdateOptionalParams): Promise<Workbook>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
ブック リソースの名前。 値は UUID である必要があります。
- workbookProperties
- Workbook
新しいブックを作成するために指定する必要があるプロパティ。
オプション パラメーター。
戻り値
Promise<Workbook>
delete(string, string, WorkbooksDeleteOptionalParams)
ブックを削除します。
function delete(resourceGroupName: string, resourceName: string, options?: WorkbooksDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
ブック リソースの名前。 値は UUID である必要があります。
- options
- WorkbooksDeleteOptionalParams
オプション パラメーター。
戻り値
Promise<void>
get(string, string, WorkbooksGetOptionalParams)
resourceName で 1 つのブックを取得します。
function get(resourceGroupName: string, resourceName: string, options?: WorkbooksGetOptionalParams): Promise<Workbook>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
ブック リソースの名前。 値は UUID である必要があります。
- options
- WorkbooksGetOptionalParams
オプション パラメーター。
戻り値
Promise<Workbook>
listByResourceGroup(string, string, WorkbooksListByResourceGroupOptionalParams)
指定したリソース グループとカテゴリ内で定義されているすべてのブックを取得します。
function listByResourceGroup(resourceGroupName: string, category: string, options?: WorkbooksListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Workbook, Workbook[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- category
-
string
返されるブックのカテゴリ。
オプション パラメーター。
戻り値
listBySubscription(string, WorkbooksListBySubscriptionOptionalParams)
指定したサブスクリプションとカテゴリ内で定義されているすべてのブックを取得します。
function listBySubscription(category: string, options?: WorkbooksListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Workbook, Workbook[], PageSettings>パラメーター
- category
-
string
返されるブックのカテゴリ。
オプション パラメーター。
戻り値
listRevisionsList(string, string, WorkbooksRevisionsListOptionalParams)
resourceName で定義されたブックのリビジョンを取得します。
function listRevisionsList(resourceGroupName: string, resourceName: string, options?: WorkbooksRevisionsListOptionalParams): PagedAsyncIterableIterator<Workbook, Workbook[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
ブック リソースの名前。 値は UUID である必要があります。
オプション パラメーター。
戻り値
revisionGet(string, string, string, WorkbooksRevisionGetOptionalParams)
revisionId によって定義された単一のブックリビジョンを取得します。
function revisionGet(resourceGroupName: string, resourceName: string, revisionId: string, options?: WorkbooksRevisionGetOptionalParams): Promise<Workbook>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
ブック リソースの名前。 値は UUID である必要があります。
- revisionId
-
string
ブックのリビジョンの ID。
オプション パラメーター。
戻り値
Promise<Workbook>
update(string, string, WorkbooksUpdateOptionalParams)
既に追加されているブックを更新します。
function update(resourceGroupName: string, resourceName: string, options?: WorkbooksUpdateOptionalParams): Promise<Workbook>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- resourceName
-
string
ブック リソースの名前。 値は UUID である必要があります。
- options
- WorkbooksUpdateOptionalParams
オプション パラメーター。
戻り値
Promise<Workbook>
