Sub Account Tag Rules - Get

Riferimento

Service:: Logz

API Version:: 2020-10-01

Ottenere un set di regole tag per una determinata risorsa di monitoraggio.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
monitorName	path	True	string	Monitorare il nome della risorsa
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
ruleSetName	path	True	string
subAccountName	path	True	string	Nome risorsa account secondario
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	MonitoringTagRules	Operazione riuscita
Other Status Codes	ErrorResponse	Risposta di errore predefinita.

Esempio

SubAccountTagRules_Get

Sample Request

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

/** 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

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

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"
        }
      ]
    }
  }
}

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
FilteringTag	Definizione di un tag di filtro. I tag di filtro vengono usati per l'acquisizione di risorse e includono/escluderli dal monitoraggio.
LogRules	Set di regole per l'invio di log per la risorsa Monitoraggio.
MonitoringTagRules	Acquisire i log e le metriche delle risorse di Azure in base ai tag arm.
MonitoringTagRulesProperties	Definizione delle proprietà per una risorsa TagRules.
ProvisioningState	Flag che specifica se lo stato di provisioning delle risorse viene rilevato da ARM.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
TagAction	Azioni valide per un tag di filtro. L'esclusione ha la priorità sull'inclusione.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

FilteringTag

Definizione di un tag di filtro. I tag di filtro vengono usati per l'acquisizione di risorse e includono/escluderli dal monitoraggio.

Nome	Tipo	Descrizione
action	TagAction	Azioni valide per un tag di filtro. L'esclusione ha la priorità sull'inclusione.
name	string	Nome (noto anche come chiave) del tag.
value	string	Valore del tag.

LogRules

Set di regole per l'invio di log per la risorsa Monitoraggio.

Nome	Tipo	Descrizione
filteringTags	FilteringTag[]	Elenco dei tag di filtro da usare per l'acquisizione dei log. Questa operazione ha effetto solo se il flag SendActivityLogs è abilitato. Se vuoto, tutte le risorse verranno acquisite. Se viene specificata solo l'azione Escludi, le regole verranno applicate all'elenco di tutte le risorse disponibili. Se vengono specificate azioni Include, le regole includono solo le risorse con i tag associati.
sendAadLogs	boolean	Flag che specifica se i log AAD devono essere inviati per la risorsa Monitoraggio.
sendActivityLogs	boolean	Contrassegno che specifica se i log attività dalle risorse di Azure devono essere inviati per la risorsa Monitoraggio.
sendSubscriptionLogs	boolean	Flag che specifica se i log delle sottoscrizioni devono essere inviati per la risorsa Monitoraggio.

MonitoringTagRules

Acquisire i log e le metriche delle risorse di Azure in base ai tag arm.

Nome	Tipo	Descrizione
id	string	ID del set di regole.
name	string	Nome del set di regole.
properties	MonitoringTagRulesProperties	Definizione delle proprietà per una risorsa TagRules.
systemData	systemData	Metadati di sistema relativi a questa risorsa
type	string	Tipo del set di regole.

MonitoringTagRulesProperties

Definizione delle proprietà per una risorsa TagRules.

Nome	Tipo	Descrizione
logRules	LogRules	Set di regole per l'invio di log per la risorsa Monitoraggio.
provisioningState	ProvisioningState	Flag che specifica se lo stato di provisioning delle risorse viene rilevato da ARM.
systemData	systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

ProvisioningState

Flag che specifica se lo stato di provisioning delle risorse viene rilevato da ARM.

Nome	Tipo	Descrizione
Accepted	string
Canceled	string
Creating	string
Deleted	string
Deleting	string
Failed	string
NotSpecified	string
Succeeded	string
Updating	string

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima risorsa.

TagAction

Azioni valide per un tag di filtro. L'esclusione ha la priorità sull'inclusione.

Nome	Tipo	Descrizione
Exclude	string
Include	string

Sub Account Tag Rules - Get

Parametri dell'URI

Risposte

Esempio

SubAccountTagRules_Get

Sample Request

Sample Response

Definizioni

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FilteringTag

LogRules

MonitoringTagRules

MonitoringTagRulesProperties

ProvisioningState

systemData

TagAction

Risorse aggiuntive