Workspace Manager Assignment Jobs - Create

Reference

Služba:: Sentinel

Verze rozhraní API:: 2024-01-01-preview

Vytvoření úlohy pro zadané přiřazení správce pracovního prostoru

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
subscriptionId	path	True	string	ID cílového předplatného.
workspaceManagerAssignmentName	path	True	string	Název přiřazení správce pracovního prostoru Vzor regulárního výrazu: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
workspaceName	path	True	string	Název pracovního prostoru. Vzor regulárního výrazu: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	Job	Vytvořeno
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Creates a job for the specified workspace manager assignment

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

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Definice

Name	Description
createdByType	Typ identity, která vytvořila prostředek.
error	Popis chyby, proč publikace selhala
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Odpověď na chybu
Job	Úloha přiřazení
jobItem	Entita popisující stav publikování položky obsahu.
provisioningState	Stav poslední úlohy přidružené k tomuto přiřazení
status	Stav publikace položky
systemData	Metadata týkající se vytvoření a poslední změny prostředku

createdByType

Typ identity, která vytvořila prostředek.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

error

Popis chyby, proč publikace selhala

Name	Typ	Description
errorMessage	string	Chybová zpráva
memberResourceName	string	Název člena prostředku, u kterého došlo k chybě publikování

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Odpověď na chybu

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

Job

Úloha přiřazení

Name	Typ	Description
etag	string	Značka Etag prostředku Azure
id	string	Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.endTime	string	Čas dokončení úlohy
properties.errorMessage	string	Zpráva k popisu chyby, pokud existuje chyba
properties.items	jobItem[]	Seznam položek publikovaných úlohou
properties.provisioningState	provisioningState	Stav úlohy
properties.startTime	string	Čas spuštění úlohy
systemData	systemData	Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

jobItem

Entita popisující stav publikování položky obsahu.

Name	Typ	Description
errors	error[]	Seznam popisů chyb, pokud publikace položky selže.
executionTime	string	Čas dokončení publikování položky
resourceId	string	ID prostředku položky obsahu
status	status	Stav publikace položky

provisioningState

Stav poslední úlohy přidružené k tomuto přiřazení

Name	Typ	Description
Canceled	string	Úloha byla zrušena.
Failed	string	Úloha selhala.
InProgress	string	Úloha právě probíhá.
Succeeded	string	Úloha byla úspěšná.

status

Stav publikace položky

Name	Typ	Description
Failed	string	Publikování položky se nezdařilo.
InProgress	string	Probíhá publikování položky
Succeeded	string	Publikace položky byla úspěšná.

systemData

Metadata týkající se vytvoření a poslední změny prostředku

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která vytvořila prostředek.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Sdílet prostřednictvím