Workspace Manager Assignment Jobs - Get

Servizio:

Sentinel

Versione API:

2024-01-01-preview

Ottiene un processo

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
jobName	path	True	string pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Nome del processo
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
workspaceManagerAssignmentName	path	True	string pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Nome dell'assegnazione del responsabile dell'area di lavoro
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Nome dell'area di lavoro.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	Job	OK
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Get a workspace manager job

Esempio di richiesta

HTTP

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

dotnet

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

Risposta di esempio

Codice di stato:

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"
  }
}

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
error	Descrizione dell'errore per il motivo per cui una pubblicazione non è riuscita
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
Job	Processo di assegnazione
jobItem	Entità che descrive lo stato di pubblicazione di un elemento di contenuto.
provisioningState	Stato dell'ultimo processo associato a questa assegnazione
status	Stato della pubblicazione dell'elemento
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
Application
Key
ManagedIdentity
User

error

Object

Descrizione dell'errore per il motivo per cui una pubblicazione non è riuscita

Nome	Tipo	Descrizione
errorMessage	string	Messaggio di errore
memberResourceName	string	Nome della risorsa membro per cui si è verificato l'errore di pubblicazione

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

Job

Object

Processo di assegnazione

Nome	Tipo	Descrizione
etag	string	Etag della risorsa di Azure
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nome della risorsa
properties.endTime	string (date-time)	Ora di completamento del processo
properties.errorMessage	string	Messaggio per descrivere l'errore, se esiste un errore
properties.items	jobItem[]	Elenco di elementi pubblicati dal processo
properties.provisioningState	provisioningState	Stato del processo
properties.startTime	string (date-time)	Ora di avvio del processo
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

jobItem

Object

Entità che descrive lo stato di pubblicazione di un elemento di contenuto.

Nome	Tipo	Descrizione
errors	error[]	Elenco delle descrizioni degli errori se la pubblicazione dell'elemento ha esito negativo.
executionTime	string (date-time)	Ora in cui la pubblicazione dell'elemento è stata completata
resourceId	string	ID risorsa dell'elemento di contenuto
status	status	Stato della pubblicazione dell'elemento

provisioningState

Enumerazione

Stato dell'ultimo processo associato a questa assegnazione

Valore	Descrizione
Canceled	Il processo è stato annullato
Failed	Il processo non è riuscito
InProgress	Il processo è in corso
Succeeded	Il processo è riuscito

status

Enumerazione

Stato della pubblicazione dell'elemento

Valore	Descrizione
Failed	Pubblicazione dell'elemento non riuscita
InProgress	La pubblicazione dell'elemento è in corso
Succeeded	Pubblicazione dell'elemento completata

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.