HttpPipeline.CreateClientRequestIdScope(String) Method

Definition

Namespace:

Azure.Core.Pipeline

Assembly:

Azure.Core.dll

Package:

Azure.Core v1.44.1

Source:

HttpPipeline.cs

Creates a scope in which all outgoing requests would use the provided

public static IDisposable CreateClientRequestIdScope (string? clientRequestId);

static member CreateClientRequestIdScope : string -> IDisposable

Public Shared Function CreateClientRequestIdScope (clientRequestId As String) As IDisposable

Parameters

clientRequestId

String

The client request id value to be sent with request.

Returns

IDisposable

The IDisposable instance that needs to be disposed when client request id shouldn't be sent anymore.

Examples

Sample usage:

var secretClient = new SecretClient(new Uri("http://example.com"), new DefaultAzureCredential());

using (HttpPipeline.CreateClientRequestIdScope("<custom-client-request-id>"))
{
    // The HTTP request resulting from the client call would have x-ms-client-request-id value set to <custom-client-request-id>
    secretClient.GetSecret("<secret-name>");
}