Workspace Manager Assignment Jobs - Get

Referenz

Dienst:: Sentinel

API-Version:: 2024-01-01-preview

Ruft einen Auftrag ab

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
jobName	path	True	string pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Der Auftragsname
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
workspaceManagerAssignmentName	path	True	string pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Der Name der Arbeitsbereichs-Manager-Zuweisung
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Der Name des Arbeitsbereichs.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	Job	OKAY
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get a workspace manager job

GET 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/cfbe1338-8276-4d5d-8b96-931117f9fa0e?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;

// Generated from example definition: specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2024-01-01-preview/examples/workspaceManagerAssignments/GetJob.json
// this example is just showing the usage of "WorkspaceManagerAssignmentJobs_Get" 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);

// get the collection of this WorkspaceManagerAssignmentJobResource
WorkspaceManagerAssignmentJobCollection collection = workspaceManagerAssignment.GetWorkspaceManagerAssignmentJobs();

// invoke the operation
string jobName = "cfbe1338-8276-4d5d-8b96-931117f9fa0e";
NullableResponse<WorkspaceManagerAssignmentJobResource> response = await collection.GetIfExistsAsync(jobName);
WorkspaceManagerAssignmentJobResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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

Beispiel für eine Antwort

Statuscode:: 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": {
    "endTime": "2022-06-14T04:52:52.9614956Z",
    "items": [
      {
        "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleOne",
        "status": "Succeeded",
        "executionTime": "2022-06-14T04:49:52.9614956Z"
      },
      {
        "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleTwo",
        "status": "Failed",
        "executionTime": "2022-06-14T04:50:52.9614956Z",
        "errors": [
          {
            "memberResourceName": "f5fa104e-c0e3-4747-9182-d342dc048a9e",
            "errorMessage": "Failed to write. Status code: Forbidden."
          }
        ]
      }
    ],
    "startTime": "2022-06-14T04:47:52.9614956Z",
    "provisioningState": "Failed"
  }
}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
error	Die Fehlerbeschreibung, warum eine Publikation fehlgeschlagen ist
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
Job	Der Aufgabenauftrag
jobItem	Eine Entität, die den Veröffentlichungsstatus eines Inhaltselements beschreibt.
provisioningState	Status des letzten Auftrags, der dieser Zuordnung zugeordnet ist
status	Status der Elementveröffentlichung
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

error

Objekt

Die Fehlerbeschreibung, warum eine Publikation fehlgeschlagen ist

Name	Typ	Beschreibung
errorMessage	string	Die Fehlermeldung
memberResourceName	string	Der Memberressourcenname, für den der Publikationsfehler aufgetreten ist

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

Job

Objekt

Der Aufgabenauftrag

Name	Typ	Beschreibung
etag	string	Etag der Azure-Ressource
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.endTime	string (date-time)	Der Zeitpunkt, zu dem der Auftrag abgeschlossen wurde
properties.errorMessage	string	Meldung zur Beschreibung des Fehlers, wenn ein Fehler vorhanden ist
properties.items	jobItem[]	Liste der vom Auftrag veröffentlichten Elemente
properties.provisioningState	provisioningState	Status des Auftrags
properties.startTime	string (date-time)	Der Zeitpunkt, zu dem der Auftrag gestartet wurde
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

jobItem

Objekt

Eine Entität, die den Veröffentlichungsstatus eines Inhaltselements beschreibt.

Name	Typ	Beschreibung
errors	error[]	Die Liste der Fehlerbeschreibungen, wenn die Elementveröffentlichung fehlschlägt.
executionTime	string (date-time)	Der Zeitpunkt, zu dem die Elementveröffentlichung abgeschlossen wurde
resourceId	string	Die Ressourcen-ID des Inhaltselements
status	status	Status der Elementveröffentlichung

provisioningState

Enumeration

Status des letzten Auftrags, der dieser Zuordnung zugeordnet ist

Wert	Beschreibung
Canceled	Der Auftrag wurde abgebrochen.
Failed	Fehler des Auftrags
InProgress	Der Auftrag wird ausgeführt.
Succeeded	Der Auftrag war erfolgreich.

status

Enumeration

Status der Elementveröffentlichung

Wert	Beschreibung
Failed	Fehler bei der Elementveröffentlichung
InProgress	Die Elementveröffentlichung wird ausgeführt.
Succeeded	Die Elementveröffentlichung war erfolgreich.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Workspace Manager Assignment Jobs - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Get a workspace manager job

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

error

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Job

jobItem

provisioningState

status

systemData

Zusätzliche Ressourcen