Sub Account Tag Rules - Create Or Update

Referência

Service:: Logz

API Version:: 2020-10-01

Criar ou atualizar um conjunto de regras de etiquetas para um determinado recurso de subconta.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
monitorName	path	True	string	Monitorizar o nome do recurso
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
ruleSetName	path	True	string
subAccountName	path	True	string	Nome do recurso da Subconta
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
properties	MonitoringTagRulesProperties	Definição das propriedades de um recurso TagRules.

Respostas

Name	Tipo	Description
200 OK	MonitoringTagRules	Com êxito
Other Status Codes	ErrorResponse	Resposta de erro predefinida.

Exemplos

SubAccountTagRules_CreateOrUpdate

Sample Request

PUT 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 CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/logz/resource-manager/Microsoft.Logz/stable/2020-10-01/examples/SubAccountTagRules_CreateOrUpdate.json
     */
    /**
     * Sample code: SubAccountTagRules_CreateOrUpdate.
     *
     * @param manager Entry point to LogzManager.
     */
    public static void subAccountTagRulesCreateOrUpdate(com.azure.resourcemanager.logz.LogzManager manager) {
        manager
            .subAccountTagRules()
            .createOrUpdateWithResponse(
                "myResourceGroup", "myMonitor", "SubAccount1", "default", null, 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_create_or_update.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.create_or_update(
        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_CreateOrUpdate.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_CreateOrUpdate.json
func ExampleSubAccountTagRulesClient_CreateOrUpdate() {
	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().CreateOrUpdate(ctx, "myResourceGroup", "myMonitor", "SubAccount1", "default", &armlogz.SubAccountTagRulesClientCreateOrUpdateOptions{Body: 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/accounts/SubAccount1/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/accounts/SubAccount1/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"
        }
      ]
    }
  }
}

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
FilteringTag	A definição de uma etiqueta de filtragem. As etiquetas de filtragem são utilizadas para capturar recursos e incluí-las/excluí-las de serem monitorizadas.
LogRules	Conjunto de regras para enviar registos para o recurso Monitor.
MonitoringTagRules	Capture registos e métricas de recursos do Azure com base em etiquetas ARM.
MonitoringTagRulesProperties	Definição das propriedades de um recurso TagRules.
ProvisioningState	Sinalizador a especificar se o estado de aprovisionamento de recursos é controlado pelo ARM.
systemData	Metadados relativos à criação e última modificação do recurso.
TagAction	Ações válidas para uma etiqueta de filtragem. A exclusão tem prioridade sobre a inclusão.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

FilteringTag

A definição de uma etiqueta de filtragem. As etiquetas de filtragem são utilizadas para capturar recursos e incluí-las/excluí-las de serem monitorizadas.

Name	Tipo	Description
action	TagAction	Ações válidas para uma etiqueta de filtragem. A exclusão tem prioridade sobre a inclusão.
name	string	O nome (também conhecido como a chave) da etiqueta.
value	string	O valor da etiqueta.

LogRules

Conjunto de regras para enviar registos para o recurso Monitor.

Name	Tipo	Description
filteringTags	FilteringTag[]	Lista de etiquetas de filtragem a utilizar para capturar registos. Isto só entra em vigor se o sinalizador SendActivityLogs estiver ativado. Se estiverem vazios, todos os recursos serão capturados. Se apenas for especificada a ação Excluir, as regras serão aplicadas à lista de todos os recursos disponíveis. Se as ações Incluir forem especificadas, as regras só incluirão recursos com as etiquetas associadas.
sendAadLogs	boolean	Sinalizador a especificar se os registos do AAD devem ser enviados para o recurso Monitor.
sendActivityLogs	boolean	Sinalizador a especificar se os registos de atividades dos recursos do Azure devem ser enviados para o recurso Monitor.
sendSubscriptionLogs	boolean	Sinalizador a especificar se os registos de subscrição devem ser enviados para o recurso Monitor.

MonitoringTagRules

Capture registos e métricas de recursos do Azure com base em etiquetas ARM.

Name	Tipo	Description
id	string	O ID do conjunto de regras.
name	string	Nome do conjunto de regras.
properties	MonitoringTagRulesProperties	Definição das propriedades de um recurso TagRules.
systemData	systemData	Os metadados do sistema relacionados com este recurso
type	string	O tipo do conjunto de regras.

MonitoringTagRulesProperties

Definição das propriedades de um recurso TagRules.

Name	Tipo	Description
logRules	LogRules	Conjunto de regras para enviar registos para o recurso Monitor.
provisioningState	ProvisioningState	Sinalizador a especificar se o estado de aprovisionamento de recursos é controlado pelo ARM.
systemData	systemData	Metadados relativos à criação e última modificação do recurso.

ProvisioningState

Sinalizador a especificar se o estado de aprovisionamento de recursos é controlado pelo ARM.

Name	Tipo	Description
Accepted	string
Canceled	string
Creating	string
Deleted	string
Deleting	string
Failed	string
NotSpecified	string
Succeeded	string
Updating	string

systemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

TagAction

Ações válidas para uma etiqueta de filtragem. A exclusão tem prioridade sobre a inclusão.

Name	Tipo	Description
Exclude	string
Include	string

Sub Account Tag Rules - Create Or Update

Parâmetros do URI

Corpo do Pedido

Respostas

Exemplos

SubAccountTagRules_CreateOrUpdate

Sample Request

Sample Response

Definições

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FilteringTag

LogRules

MonitoringTagRules

MonitoringTagRulesProperties

ProvisioningState

systemData

TagAction

Recursos adicionais