Workspace Manager Assignment Jobs - Create

サービス:

Sentinel

API バージョン:

2024-01-01-preview

指定したワークスペース マネージャーの割り当てのジョブを作成する

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/{workspaceManagerAssignmentName}/jobs?api-version=2024-01-01-preview

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソース グループの名前。 名前の大文字と小文字は区別されます。
subscriptionId	path	True	string	ターゲット サブスクリプションの ID。
workspaceManagerAssignmentName	path	True	string	ワークスペース マネージャーの割り当ての名前 正規表現パターン: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
workspaceName	path	True	string	ワークスペースの名前。 正規表現パターン: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	Job	作成済み
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントの借用

例

Creates a job for the specified workspace manager assignment

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58/jobs?api-version=2024-01-01-preview

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.SecurityInsights.Models;
using Azure.ResourceManager.SecurityInsights;

// Generated from example definition: specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-01-01-preview/examples/workspaceManagerAssignments/CreateJob.json
// this example is just showing the usage of "WorkspaceManagerAssignmentJobs_Create" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this WorkspaceManagerAssignmentResource created on azure
// for more information of creating WorkspaceManagerAssignmentResource, please refer to the document of WorkspaceManagerAssignmentResource
string subscriptionId = "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0";
string resourceGroupName = "myRg";
string workspaceName = "myWorkspace";
string workspaceManagerAssignmentName = "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58";
ResourceIdentifier workspaceManagerAssignmentResourceId = WorkspaceManagerAssignmentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, workspaceManagerAssignmentName);
WorkspaceManagerAssignmentResource workspaceManagerAssignment = client.GetWorkspaceManagerAssignmentResource(workspaceManagerAssignmentResourceId);

// invoke the operation
WorkspaceManagerAssignmentJobResource result = await workspaceManagerAssignment.CreateWorkspaceManagerAssignmentJobAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
WorkspaceManagerAssignmentJobData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

200

{
  "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58/jobs/cfbe1338-8276-4d5d-8b96-931117f9fa0e",
  "etag": "\"f20a2523-7817-47b5-a3b2-21539c00c788\"",
  "name": "cfbe1338-8276-4d5d-8b96-931117f9fa0e",
  "type": "Microsoft.SecurityInsights/workspaceManagerAssignments/jobs",
  "properties": {
    "startTime": "2022-06-14T04:47:52.9614956Z",
    "provisioningState": "InProgress"
  }
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
error	パブリケーションが失敗した理由のエラーの説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
Job	割り当てジョブ
jobItem	コンテンツ アイテムの発行状態を記述するエンティティ。
provisioningState	この割り当てに関連付けられた最後のジョブの状態
status	アイテムのパブリケーションの状態
systemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

error

パブリケーションが失敗した理由のエラーの説明

名前	型	説明
errorMessage	string	エラー メッセージ
memberResourceName	string	パブリケーション エラーが発生したメンバー リソース名

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラー メッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

Job

割り当てジョブ

名前	型	説明
etag	string	Azure リソースの Etag
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.endTime	string	ジョブが完了した時刻
properties.errorMessage	string	エラーが存在する場合は、エラーを説明するメッセージ
properties.items	jobItem[]	ジョブによって発行されたアイテムの一覧
properties.provisioningState	provisioningState	ジョブの状態
properties.startTime	string	ジョブが開始された時刻
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

jobItem

コンテンツ アイテムの発行状態を記述するエンティティ。

名前	型	説明
errors	error[]	アイテムのパブリケーションが失敗した場合のエラーの説明の一覧。
executionTime	string	アイテムの発行が完了した時刻
resourceId	string	コンテンツ アイテムのリソース ID
status	status	アイテムのパブリケーションの状態

provisioningState

この割り当てに関連付けられた最後のジョブの状態

名前	型	説明
Canceled	string	ジョブが取り消されました
Failed	string	ジョブが失敗しました
InProgress	string	ジョブが進行中です
Succeeded	string	ジョブが成功しました

status

アイテムのパブリケーションの状態

名前	型	説明
Failed	string	アイテムの発行に失敗しました
InProgress	string	アイテムの発行が進行中です
Succeeded	string	アイテムの発行に成功しました

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。