Sentinel Onboarding States - Get

Služba:

Sentinel

Verze rozhraní API:

2024-01-01-preview

Získání stavu onboardingu služby Sentinel

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates/{sentinelOnboardingStateName}?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ů. Název nerozlišuje malá a velká písmena.
sentinelOnboardingStateName	path	True	string	Název stavu onboardingu služby Sentinel. Podpora – výchozí
subscriptionId	path	True	string	ID cílového předplatného.
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	SentinelOnboardingState	OK
Other Status Codes	CloudError	Chyba při získávání stavu onboardingu služby Sentinel

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

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

Get Sentinel onboarding state

Ukázkový požadavek

HTTP

GET https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/onboardingStates/default?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/onboardingStates/GetSentinelOnboardingState.json
// this example is just showing the usage of "SentinelOnboardingStates_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 SecurityInsightsSentinelOnboardingStateResource created on azure
// for more information of creating SecurityInsightsSentinelOnboardingStateResource, please refer to the document of SecurityInsightsSentinelOnboardingStateResource
string subscriptionId = "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0";
string resourceGroupName = "myRg";
string workspaceName = "myWorkspace";
string sentinelOnboardingStateName = "default";
ResourceIdentifier securityInsightsSentinelOnboardingStateResourceId = SecurityInsightsSentinelOnboardingStateResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, sentinelOnboardingStateName);
SecurityInsightsSentinelOnboardingStateResource securityInsightsSentinelOnboardingState = client.GetSecurityInsightsSentinelOnboardingStateResource(securityInsightsSentinelOnboardingStateResourceId);

// invoke the operation
SecurityInsightsSentinelOnboardingStateResource result = await securityInsightsSentinelOnboardingState.GetAsync();

// 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
SecurityInsightsSentinelOnboardingStateData 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.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/onboardingStates/default",
  "name": "default",
  "type": "Microsoft.SecurityInsights/onboardingStates",
  "properties": {
    "customerManagedKey": false
  }
}

Definice

Name	Description
CloudError	Struktura odpovědi na chybu
CloudErrorBody	Podrobnosti o chybě
createdByType	Typ identity, která prostředek vytvořila.
SentinelOnboardingState	Stav onboardingu služby Sentinel
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

CloudError

Objekt

Struktura odpovědi na chybu

Name	Typ	Description
error	CloudErrorBody	Data o chybách

CloudErrorBody

Objekt

Podrobnosti o chybě

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.

createdByType

Výčet

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

Hodnota	Description
Application
Key
ManagedIdentity
User

SentinelOnboardingState

Objekt

Stav onboardingu služby Sentinel

Name	Typ	Description
etag	string	Označení prostředku Azure
id	string	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties.customerManagedKey	boolean	Příznak označující stav nastavení CMK
systemData	systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

systemData

Objekt

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á prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.