Workspace Settings - Get

Dienst:: Defender for Cloud

API-Version:: 2017-08-01-preview

Einstellungen dazu, wo ihre Sicherheitsdaten und Protokolle gespeichert werden sollen. Wenn das Ergebnis leer ist, bedeutet dies, dass keine Konfiguration des benutzerdefinierten Arbeitsbereichs festgelegt wurde.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/workspaceSettings/{workspaceSettingName}?api-version=2017-08-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
workspaceSettingName	path	True	string	Name der Sicherheitseinstellung
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	WorkspaceSetting	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	Common.CloudError	Unerwartete Fehlerantwort.

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 setting on subscription

Beispielanforderung

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default?api-version=2017-08-01-preview

package armsecurity_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)

// Generated from example definition: 2017-08-01-preview/WorkspaceSettings/GetWorkspaceSetting_example.json
func ExampleWorkspaceSettingsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("20ff7fc3-e762-44dd-bd96-b71116dcdc23", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkspaceSettingsClient().Get(ctx, "default", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsecurity.WorkspaceSettingsClientGetResponse{
	// 	WorkspaceSetting: armsecurity.WorkspaceSetting{
	// 		Name: to.Ptr("default"),
	// 		Type: to.Ptr("Microsoft.Security/workspaceSettings"),
	// 		ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default"),
	// 		Properties: &armsecurity.WorkspaceSettingProperties{
	// 			Scope: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23"),
	// 			WorkspaceID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to settings about where we should store your security data and logs. If the result is empty, it means that no custom-workspace configuration was set
 *
 * @summary settings about where we should store your security data and logs. If the result is empty, it means that no custom-workspace configuration was set
 * x-ms-original-file: 2017-08-01-preview/WorkspaceSettings/GetWorkspaceSetting_example.json
 */
async function getAWorkspaceSettingOnSubscription() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.workspaceSettings.get("default");
  console.log(result);
}

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

{
  "name": "default",
  "type": "Microsoft.Security/workspaceSettings",
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default",
  "properties": {
    "scope": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23",
    "workspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace"
  }
}

Definitionen

Name	Beschreibung
Common.CloudError	Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
Common.CloudErrorBody	Das Fehlerdetails.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
WorkspaceSetting	Konfiguriert, wo die OMS-Agentdaten für Arbeitsbereiche unter einem Bereich gespeichert werden sollen.

Common.CloudError

Objekt

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

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

Common.CloudErrorBody

Objekt

Das Fehlerdetails.

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

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

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

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.

WorkspaceSetting

Objekt

Konfiguriert, wo die OMS-Agentdaten für Arbeitsbereiche unter einem Bereich gespeichert werden sollen.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.scope	string	Alle virtuellen Computer in diesem Bereich senden ihre Sicherheitsdaten an den erwähnten Arbeitsbereich, es sei denn, sie werden durch eine Einstellung mit einem spezifischeren Bereich außer Kraft gesetzt.
properties.workspaceId	string	Die vollständige Azure-ID des Arbeitsbereichs zum Speichern der Daten in
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"