Sub Account Tag Rules - Get

Service:

Logz

API Version:

2020-10-01

Egy adott figyelőerőforráshoz tartozó címkeszabálykészlet lekérése.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/accounts/{subAccountName}/tagRules/{ruleSetName}?api-version=2020-10-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
monitorName	path	True	string	Erőforrás nevének figyelése
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
ruleSetName	path	True	string
subAccountName	path	True	string	Alfiók erőforrásának neve
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	MonitoringTagRules	Siker
Other Status Codes	ErrorResponse	Alapértelmezett hibaválasz.

Példák

SubAccountTagRules_Get

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Logz/monitors/myMonitor/accounts/SubAccount1/tagRules/default?api-version=2020-10-01

Java

/** Samples for SubAccountTagRules Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/logz/resource-manager/Microsoft.Logz/stable/2020-10-01/examples/SubAccountTagRules_Get.json
     */
    /**
     * Sample code: SubAccountTagRules_Get.
     *
     * @param manager Entry point to LogzManager.
     */
    public static void subAccountTagRulesGet(com.azure.resourcemanager.logz.LogzManager manager) {
        manager
            .subAccountTagRules()
            .getWithResponse(
                "myResourceGroup", "myMonitor", "SubAccount1", "default", com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.logz import MicrosoftLogz

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-logz
# USAGE
    python sub_account_tag_rules_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MicrosoftLogz(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.sub_account_tag_rules.get(
        resource_group_name="myResourceGroup",
        monitor_name="myMonitor",
        sub_account_name="SubAccount1",
        rule_set_name="default",
    )
    print(response)


# x-ms-original-file: specification/logz/resource-manager/Microsoft.Logz/stable/2020-10-01/examples/SubAccountTagRules_Get.json
if __name__ == "__main__":
    main()

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

Go

package armlogz_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/logz/armlogz"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/logz/resource-manager/Microsoft.Logz/stable/2020-10-01/examples/SubAccountTagRules_Get.json
func ExampleSubAccountTagRulesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armlogz.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSubAccountTagRulesClient().Get(ctx, "myResourceGroup", "myMonitor", "SubAccount1", "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.MonitoringTagRules = armlogz.MonitoringTagRules{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Logz/monitors/tagRules"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Logz/monitors/myMonitor/tagRules/default"),
	// 	Properties: &armlogz.MonitoringTagRulesProperties{
	// 		LogRules: &armlogz.LogRules{
	// 			FilteringTags: []*armlogz.FilteringTag{
	// 				{
	// 					Name: to.Ptr("Environment"),
	// 					Action: to.Ptr(armlogz.TagActionInclude),
	// 					Value: to.Ptr("Prod"),
	// 				},
	// 				{
	// 					Name: to.Ptr("Environment"),
	// 					Action: to.Ptr(armlogz.TagActionExclude),
	// 					Value: to.Ptr("Dev"),
	// 			}},
	// 			SendAADLogs: to.Ptr(false),
	// 			SendActivityLogs: to.Ptr(true),
	// 			SendSubscriptionLogs: to.Ptr(true),
	// 		},
	// 	},
	// }
}

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

Sample Response

Status code:

200

{
  "name": "default",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Logz/monitors/myMonitor/tagRules/default",
  "type": "Microsoft.Logz/monitors/tagRules",
  "properties": {
    "logRules": {
      "sendAadLogs": false,
      "sendSubscriptionLogs": true,
      "sendActivityLogs": true,
      "filteringTags": [
        {
          "name": "Environment",
          "value": "Prod",
          "action": "Include"
        },
        {
          "name": "Environment",
          "value": "Dev",
          "action": "Exclude"
        }
      ]
    }
  }
}

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
FilteringTag	A szűrőcímke definíciója. A szűrési címkék az erőforrások rögzítésére és a figyelésükbe való belefoglalásukra/kizárásukra szolgálnak.
LogRules	A figyelési erőforrás naplóinak küldésére vonatkozó szabályok készlete.
MonitoringTagRules	Rögzítse az Azure-erőforrások naplóit és metrikáit ARM-címkék alapján.
MonitoringTagRulesProperties	TagRules-erőforrás tulajdonságainak meghatározása.
ProvisioningState	Annak megjelölése, hogy az erőforrás-kiépítési állapotot az ARM nyomon követi-e.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
TagAction	Érvényes műveletek egy szűrőcímkéhez. A kizárás elsőbbséget élvez a belefoglalással szemben.

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további adattípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célja.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

FilteringTag

A szűrőcímke definíciója. A szűrési címkék az erőforrások rögzítésére és a figyelésükbe való belefoglalásukra/kizárásukra szolgálnak.

Name	Típus	Description
action	TagAction	Érvényes műveletek egy szűrőcímkéhez. A kizárás elsőbbséget élvez a belefoglalással szemben.
name	string	A címke neve (más néven kulcs).
value	string	A címke értéke.

LogRules

A figyelési erőforrás naplóinak küldésére vonatkozó szabályok készlete.

Name	Típus	Description
filteringTags	FilteringTag[]	A naplók rögzítéséhez használandó szűrési címkék listája. Ez csak akkor lép érvénybe, ha a SendActivityLogs jelző engedélyezve van. Ha üres, a rendszer minden erőforrást rögzít. Ha csak a Kizárás művelet van megadva, a szabályok az összes elérhető erőforrás listájára érvényesek lesznek. Ha a Belefoglalási műveletek meg vannak adva, a szabályok csak a társított címkékkel rendelkező erőforrásokat tartalmazzák.
sendAadLogs	boolean	Jelölő, amely megadja, hogy az AAD-naplókat el kell-e küldeni a Monitor erőforráshoz.
sendActivityLogs	boolean	Annak megjelölése, hogy az Azure-erőforrások tevékenységnaplóit el kell-e küldeni a monitorozási erőforráshoz.
sendSubscriptionLogs	boolean	Annak megjelölése, hogy az előfizetési naplókat el kell-e küldeni a Monitor erőforráshoz.

MonitoringTagRules

Rögzítse az Azure-erőforrások naplóit és metrikáit ARM-címkék alapján.

Name	Típus	Description
id	string	A szabálykészlet azonosítója.
name	string	A szabálykészlet neve.
properties	MonitoringTagRulesProperties	TagRules-erőforrás tulajdonságainak meghatározása.
systemData	systemData	Az erőforráshoz kapcsolódó rendszer metaadatai
type	string	A szabálykészlet típusa.

MonitoringTagRulesProperties

TagRules-erőforrás tulajdonságainak meghatározása.

Name	Típus	Description
logRules	LogRules	A figyelési erőforrás naplóinak küldésére vonatkozó szabályok készlete.
provisioningState	ProvisioningState	Annak megjelölése, hogy az erőforrás-kiépítési állapotot az ARM nyomon követi-e.
systemData	systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

ProvisioningState

Annak megjelölése, hogy az erőforrás-kiépítési állapotot az ARM nyomon követi-e.

Name	Típus	Description
Accepted	string
Canceled	string
Creating	string
Deleted	string
Deleting	string
Failed	string
NotSpecified	string
Succeeded	string
Updating	string

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást utoljára módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

TagAction

Érvényes műveletek egy szűrőcímkéhez. A kizárás elsőbbséget élvez a belefoglalással szemben.

Name	Típus	Description
Exclude	string
Include	string