レポート実行の一時停止 API

この API は、実行時に、スケジュールされたレポートの実行を一時停止します。

要求の構文

認証方法	要求 URI
PUT	https://api.partnercenter.microsoft.com/insights/v1/mpn/ScheduledReport/pause/{ReportID}

要求ヘッダー

Header	型	説明
承認	string	必須。 フォーム内の Microsoft Entra アクセス トークン Bearer <token>
Content-Type	string	Application/JSON

パス パラメーター

パラメーター名	型	Required	説明
reportId	string	いいえ	変更中のレポートの ID

Query parameter (クエリ パラメーター)

なし

要求ペイロード

なし

要求用語集

なし

回答

応答ペイロードは、次のように構成されます。

応答コード: 200、400、401、403、404、500

応答ペイロードの例:

{
  "Value": [
    {
      "ReportId": "string",
      "ReportName": "string",
      "Description": "string",
      "QueryId": "string",
      "Query": "string",
      "User": "string",
      "CreatedTime": "string",
      "ModifiedTime": "string",
      "ExecuteNow": true,
      "StartTime": "string",
      "ReportStatus": "string",
      "RecurrenceInterval": 0,
      "RecurrenceCount": 0,
      "CallbackUrl": "string",
      "CallbackMethod": "string",
      "Format": "string"
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0,
}

応答用語集

次の表に、応答の主な要素を定義します。

パラメーター	説明
ReportId	一時停止されたレポートの汎用一意識別子 (UUID)
ReportName	作成時にレポートに指定された名前
説明	レポートの作成時に指定された説明
QueryId	レポートの作成時に渡されたクエリ ID
クエリ	このレポートに対して実行されるクエリ テキスト
ユーザー	レポートの作成に使用されるユーザー ID
CreatedTime	レポートが作成された時刻。 時刻形式は yyyy-MM-ddTHH:mm:ssZ です。
ModifiedTime	レポートが最後に変更された時刻。 時刻形式は yyyy-MM-ddTHH:mm:ssZ です。
ExecuteNow	レポートの作成時に設定された ExecuteNow フラグ
Starttime	レポートの実行が開始される時刻。 時刻形式は yyyy-MM-ddTHH:mm:ssZ です。
ReportStatus	レポート実行の状態。 有効な値は、Paused、Active、および Inactive です。
RecurrenceInterval	レポートの作成時に指定された繰り返し間隔
RecurrenceCount	レポートの作成時に指定された繰り返し数
CallbackUrl	要求で指定されたコールバック URL
CallbackMethod	要求で指定されたコールバック メソッド
Format	レポート ファイルの形式
TotalCount	Value 配列内のデータセットの数
メッセージ	API の実行からのステータス メッセージ
StatusCode	結果コード。 指定できる値は、200、400、401、403、500 です。