Set-AzApiManagementDiagnostic

Référence

Module:: Az.ApiManagement

Modifie un diagnostic gestion des API au niveau de l’étendue Globale ou Api.

Syntaxe

Set-AzApiManagementDiagnostic
   -Context <PsApiManagementContext>
   -DiagnosticId <String>
   [-ApiId <String>]
   [-LoggerId <String>]
   [-AlwaysLog <String>]
   [-SamplingSetting <PsApiManagementSamplingSetting>]
   [-FrontEndSetting <PsApiManagementPipelineDiagnosticSetting>]
   [-BackendSetting <PsApiManagementPipelineDiagnosticSetting>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzApiManagementDiagnostic
   -InputObject <PsApiManagementDiagnostic>
   [-LoggerId <String>]
   [-AlwaysLog <String>]
   [-SamplingSetting <PsApiManagementSamplingSetting>]
   [-FrontEndSetting <PsApiManagementPipelineDiagnosticSetting>]
   [-BackendSetting <PsApiManagementPipelineDiagnosticSetting>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzApiManagementDiagnostic
   -ResourceId <String>
   [-LoggerId <String>]
   [-AlwaysLog <String>]
   [-SamplingSetting <PsApiManagementSamplingSetting>]
   [-FrontEndSetting <PsApiManagementPipelineDiagnosticSetting>]
   [-BackendSetting <PsApiManagementPipelineDiagnosticSetting>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

L’applet de commande Set-AzApiManagementDiagnostic met à jour les diagnostics configurés dans l’étendue globale ou api.

Exemples

Exemple 1 : Modifier un diagnostic dans l’étendue globale

$context =New-AzApiManagementContext -ResourceGroupName Api-Default-WestUS -ServiceName contoso
$diagnostic=Get-AzApiManagementDiagnostic -Context $context -DiagnosticId "applicationinsights"
$diagnostic

DiagnosticId      : applicationinsights
AlwaysLog         : allErrors
LoggerId          : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/loggers/backendapisachinc
Sampling          : Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSamplingSetting
Frontend          :
Backend           :
Id                : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/diagnostics/applicationinsights
ResourceGroupName : Api-Default-WestUS
ServiceName       : contoso


$diagnostic.Sampling

SamplingType Percentage
------------ ----------
fixed               100

$diagnostic.Sampling.Percentage = 50
$diagnostic.Sampling

SamplingType Percentage
------------ ----------
fixed                50

Set-AzApiManagementDiagnostic -InputObject $diagnostic

Cette commande modifie le pourcentage d’échantillonnage de diagnostic spécifié de 100 à 50%

Exemple 2

Modifie un diagnostic gestion des API au niveau de l’étendue Globale ou Api. (généré automatiquement)

Set-AzApiManagementDiagnostic -AlwaysLog allErrors -ApiId '0001' -Context <PsApiManagementContext> -DiagnosticId 'applicationinsights' -LoggerId 'Logger123' -SamplingSetting <PsApiManagementSamplingSetting>

Paramètres

-AlwaysLog

Spécifie le type de paramètres d’échantillonnage des messages qui ne doivent pas s’appliquer. Ce paramètre est facultatif.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-ApiId

Identificateur de l’API existante. Ce paramètre est facultatif.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-BackendSetting

Paramètre de diagnostic pour les messages Http entrants/sortants vers le serveur principal. Ce paramètre est facultatif.

Type:	PsApiManagementPipelineDiagnosticSetting
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Type:	SwitchParameter
Alias:	cf
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Context

Instance de PsApiManagementContext. Ce paramètre est requis.

Type:	PsApiManagementContext
Position:	Named
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Type:	IAzureContextContainer
Alias:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-DiagnosticId

Identificateur du diagnostic existant. Ce paramètre est requis.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-FrontEndSetting

Paramètre de diagnostic pour les messages Http entrants/sortants vers la passerelle. Ce paramètre est facultatif.

Type:	PsApiManagementPipelineDiagnosticSetting
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-InputObject

Instance de PsApiManagementDiagnostic. Ce paramètre est requis.

Type:	PsApiManagementDiagnostic
Position:	Named
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-LoggerId

Identificateur de l’enregistreur d’événements vers lequel envoyer (push) les diagnostics. Ce paramètre est requis.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-PassThru

Si elle est spécifiée, l’instance de Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementDiagnostic représente le diagnostic défini.

Type:	SwitchParameter
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-ResourceId

Arm ResourceId de diagnostic ou de diagnostic d’API. Ce paramètre est requis.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-SamplingSetting

Paramètre d’échantillonnage du diagnostic. Ce paramètre est facultatif.

Type:	PsApiManagementSamplingSetting
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.

Type:	SwitchParameter
Alias:	wi
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False