Workspace Manager Assignment Jobs - Create

Référence

Service:: Sentinel

Version d'API:: 2024-01-01-preview

Créer un travail pour l’affectation de gestionnaire d’espace de travail spécifiée

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
workspaceManagerAssignmentName	path	True	string	Nom de l’affectation du gestionnaire d’espace de travail Modèle d’expression régulière: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
workspaceName	path	True	string	Nom de l’espace de travail. Modèle d’expression régulière: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	Job	Date de création
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Exemple de réponse

Code d’état:: 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"
  }
}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
error	Description de l’erreur pour la raison de l’échec d’une publication
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
Job	Travail d’affectation
jobItem	Entité décrivant le status de publication d’un élément de contenu.
provisioningState	État du dernier travail associé à cette affectation
status	État de la publication de l’élément
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

error

Description de l’erreur pour la raison de l’échec d’une publication

Nom	Type	Description
errorMessage	string	Message d'erreur.
memberResourceName	string	Nom de la ressource membre pour laquelle l’erreur de publication s’est produite

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

Job

Travail d’affectation

Nom	Type	Description
etag	string	Etag de la ressource Azure
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nom de la ressource.
properties.endTime	string	Heure à laquelle le travail s’est terminé
properties.errorMessage	string	Message pour décrire l’erreur, si une erreur existe
properties.items	jobItem[]	Liste des éléments publiés par le travail
properties.provisioningState	provisioningState	État du travail
properties.startTime	string	Heure à laquelle le travail a démarré
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

jobItem

Entité décrivant le status de publication d’un élément de contenu.

Nom	Type	Description
errors	error[]	Liste des descriptions d’erreur en cas d’échec de la publication de l’élément.
executionTime	string	Heure à laquelle la publication de l’élément a été terminée
resourceId	string	ID de ressource de l’élément de contenu
status	status	État de la publication de l’élément

provisioningState

État du dernier travail associé à cette affectation

Nom	Type	Description
Canceled	string	Le travail a été annulé
Failed	string	Échec du travail
InProgress	string	Le travail est en cours
Succeeded	string	Le travail a réussi

status

État de la publication de l’élément

Nom	Type	Description
Failed	string	Échec de la publication de l’élément
InProgress	string	La publication de l’élément est en cours
Succeeded	string	La publication de l’élément a réussi

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la dernière ressource.
lastModifiedByType	createdByType	Type d’identité qui a modifié la dernière ressource.

Partager via