Workspaces - List

Service:

Log Analytics

API Version:

2023-09-01

Hiermee haalt u de werkruimten in een abonnement op.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/workspaces?api-version=2023-09-01

URI-parameters

Name	In	Vereist	Type	Description
subscriptionId	path	True	string	De id van het doelabonnement.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	WorkspaceListResult	Definitie van OK-antwoord.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

WorkspacesSubscriptionList

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/providers/Microsoft.OperationalInsights/workspaces?api-version=2023-09-01

Sample Response

Status code:

200

{
  "value": [
    {
      "properties": {
        "customerId": "bc089d7b-485c-4aff-a71e-c00f362d8d2f",
        "provisioningState": "Succeeded",
        "sku": {
          "name": "PerGB2018"
        },
        "retentionInDays": 30,
        "publicNetworkAccessForQuery": "Enabled",
        "publicNetworkAccessForIngestion": "Enabled"
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourcegroups/oiautorest6685/providers/microsoft.operationalinsights/workspaces/aztest2170",
      "name": "AzTest2170",
      "type": "Microsoft.OperationalInsights/workspaces",
      "location": "australiasoutheast",
      "tags": {
        "tag1": "val1"
      }
    }
  ]
}

Definities

Name	Description
CapacityReservationLevel	Het capaciteitsreserveringsniveau in GB voor deze werkruimte, wanneer de SKU CapacityReservation is geselecteerd.
createdByType	Het type identiteit waarmee de resource is gemaakt.
DataIngestionStatus	De status van gegevensopname voor deze werkruimte.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
Identity	Identiteit voor de resource.
IdentityType	Type beheerde service-identiteit.
PrivateLinkScopedResource	De resourcereferentie voor het privékoppelingsbereik.
PublicNetworkAccessType	Het netwerktoegangstype voor gebruik in de Log Analytics-werkruimte. Standaard is deze ingeschakeld
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
UserIdentityProperties	Door de gebruiker toegewezen identiteitseigenschappen.
Workspace	De werkruimteresourcecontainer op het hoogste niveau.
WorkspaceCapping	De dagelijkse volumelimiet voor opname.
WorkspaceEntityStatus	De inrichtingsstatus van de werkruimte.
WorkspaceFeatures	Werkruimtefuncties.
WorkspaceListResult	Het antwoord van de bewerking lijstwerkruimten.
WorkspaceSku	De SKU (laag) van een werkruimte.
WorkspaceSkuNameEnum	De naam van de SKU.

CapacityReservationLevel

Het capaciteitsreserveringsniveau in GB voor deze werkruimte, wanneer de SKU CapacityReservation is geselecteerd.

Name	Type	Description
100	Integer
1000	Integer
10000	Integer
200	Integer
2000	Integer
25000	Integer
300	Integer
400	Integer
500	Integer
5000	Integer
50000	Integer

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataIngestionStatus

De status van gegevensopname voor deze werkruimte.

Name	Type	Description
ApproachingQuota	string	80% van het dagelijkse quotum bereikt.
ForceOff	string	De opname is gestopt na een wijziging in de service-instelling.
ForceOn	string	Opname is gestart na wijziging van de service-instelling.
OverQuota	string	Het quotum voor de dagelijkse limiet is bereikt, de opname is gestopt.
RespectQuota	string	Opname is ingeschakeld na het dagelijks opnieuw instellen van het quotum voor de limiet of het inschakelen van het abonnement.
SubscriptionSuspended	string	Opname is gestopt na onderbroken abonnement.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

Identity

Identiteit voor de resource.

Name	Type	Description
principalId	string	De principal-id van resource-id.
tenantId	string	De tenant-id van de resource.
type	IdentityType	Type beheerde service-identiteit.
userAssignedIdentities	<string,  UserIdentityProperties>	De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

IdentityType

Type beheerde service-identiteit.

Name	Type	Description
None	string
SystemAssigned	string
UserAssigned	string

PrivateLinkScopedResource

De resourcereferentie voor het privékoppelingsbereik.

Name	Type	Description
resourceId	string	De volledige resource-id van de private link-bereikresource.
scopeId	string	De unieke id van het bereik van de privékoppeling.

PublicNetworkAccessType

Het netwerktoegangstype voor gebruik in de Log Analytics-werkruimte. Standaard is deze ingeschakeld

Name	Type	Description
Disabled	string	Hiermee schakelt u openbare connectiviteit met Log Analytics via openbare DNS uit.
Enabled	string	Hiermee schakelt u connectiviteit met Log Analytics via openbare DNS in.

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit die de resource heeft gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	Het tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

UserIdentityProperties

Door de gebruiker toegewezen identiteitseigenschappen.

Name	Type	Description
clientId	string	De client-id van de door de gebruiker toegewezen identiteit.
principalId	string	De principal-id van de door de gebruiker toegewezen identiteit.

Workspace

De werkruimteresourcecontainer op het hoogste niveau.

Name	Type	Standaardwaarde	Description
etag	string		De etag van de werkruimte.
id	string		Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		De identiteit van de resource.
location	string		De geografische locatie waar de resource zich bevindt
name	string		De naam van de resource
properties.createdDate	string		Aanmaakdatum van werkruimte.
properties.customerId	string		Dit is een eigenschap met het kenmerk Alleen-lezen. Vertegenwoordigt de id die is gekoppeld aan de werkruimte.
properties.defaultDataCollectionRuleResourceId	string		De resource-id van de standaardregel voor gegevensverzameling die voor deze werkruimte moet worden gebruikt. Verwachte indeling is : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
properties.features	WorkspaceFeatures		Werkruimtefuncties.
properties.forceCmkForQuery	boolean		Geeft aan of door de klant beheerde opslag verplicht is voor querybeheer.
properties.modifiedDate	string		Wijzigingsdatum van werkruimte.
properties.privateLinkScopedResources	PrivateLinkScopedResource[]		Lijst met gekoppelde privékoppelingsbereikresources.
properties.provisioningState	WorkspaceEntityStatus		De inrichtingsstatus van de werkruimte.
properties.publicNetworkAccessForIngestion	PublicNetworkAccessType	Enabled	Het netwerktoegangstype voor toegang tot Log Analytics-opname.
properties.publicNetworkAccessForQuery	PublicNetworkAccessType	Enabled	Het netwerktoegangstype voor toegang tot Log Analytics-query.
properties.retentionInDays	integer		De gegevensretentie van de werkruimte in dagen. Toegestane waarden zijn per prijsplan. Zie de documentatie voor prijscategorieën voor meer informatie.
properties.sku	WorkspaceSku		De SKU van de werkruimte.
properties.workspaceCapping	WorkspaceCapping		De dagelijkse volumelimiet voor opname.
systemData	systemData		Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
tags	object		Resourcetags.
type	string		Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

WorkspaceCapping

De dagelijkse volumelimiet voor opname.

Name	Type	Description
dailyQuotaGb	number	Het dagelijkse quotum voor de werkruimte voor opname.
dataIngestionStatus	DataIngestionStatus	De status van gegevensopname voor deze werkruimte.
quotaNextResetTime	string	De tijd waarop het quotum rust is.

WorkspaceEntityStatus

De inrichtingsstatus van de werkruimte.

Name	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
ProvisioningAccount	string
Succeeded	string
Updating	string

WorkspaceFeatures

Werkruimtefuncties.

Name	Type	Description
clusterResourceId	string	Toegewezen LA-cluster resourceId die is gekoppeld aan de werkruimten.
disableLocalAuth	boolean	Niet-AAD-verificatie uitschakelen.
enableDataExport	boolean	Vlag die aangeeft of gegevens moeten worden geëxporteerd.
enableLogAccessUsingOnlyResourcePermissions	boolean	Vlag die aangeeft welke machtiging moet worden gebruikt: resource of werkruimte of beide.
immediatePurgeDataOn30Days	boolean	Vlag die aangeeft of we de gegevens na 30 dagen willen verwijderen.
unifiedSentinelBillingOnly	boolean	Een indicatie of de opgegeven werkruimte alleen is beperkt tot het geïntegreerde factureringsmodel van Sentinel.

WorkspaceListResult

Het antwoord van de bewerking lijstwerkruimten.

Name	Type	Description
value	Workspace[]	Een lijst met werkruimten.

WorkspaceSku

De SKU (laag) van een werkruimte.

Name	Type	Description
capacityReservationLevel	CapacityReservationLevel	Het capaciteitsreserveringsniveau in GB voor deze werkruimte, wanneer de SKU CapacityReservation is geselecteerd.
lastSkuUpdate	string	De laatste keer dat de SKU is bijgewerkt.
name	WorkspaceSkuNameEnum	De naam van de SKU.

WorkspaceSkuNameEnum

De naam van de SKU.

Name	Type	Description
CapacityReservation	string
Free	string
LACluster	string
PerGB2018	string
PerNode	string
Premium	string
Standalone	string
Standard	string