CodeTransparencyClient.GetEntry Method

  • Reference

Definition

Namespace:
Azure.Security.CodeTransparency
Assembly:
Azure.Security.CodeTransparency.dll
Package:
Azure.Security.CodeTransparency v1.0.0-beta.2

Overloads

GetEntry(String, Nullable<Boolean>, RequestContext)

[Protocol Method] Get Entry with or without receipt embedded in its unprotected header
GetEntry(String, Nullable<Boolean>, CancellationToken)

Get Entry with or without receipt embedded in its unprotected header.

GetEntry(String, Nullable<Boolean>, RequestContext)

Source:
CodeTransparencyClient.cs

[Protocol Method] Get Entry with or without receipt embedded in its unprotected header

public virtual Azure.Response GetEntry (string entryId, bool? embedReceipt, Azure.RequestContext context);
abstract member GetEntry : string * Nullable<bool> * Azure.RequestContext -> Azure.Response
override this.GetEntry : string * Nullable<bool> * Azure.RequestContext -> Azure.Response
Public Overridable Function GetEntry (entryId As String, embedReceipt As Nullable(Of Boolean), context As RequestContext) As Response

Parameters

entryId
String

ID of the entry to retrieve.

embedReceipt
Nullable<Boolean>

Embed a receipt as part of the response.

context
RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

entryId is null.

ArgumentException

entryId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetEntry and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
CodeTransparencyClient client = new CodeTransparencyClient(endpoint, credential);

Response response = client.GetEntry("<entryId>", null, null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());

This sample shows how to call GetEntry with all parameters and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
CodeTransparencyClient client = new CodeTransparencyClient(endpoint, credential);

Response response = client.GetEntry("<entryId>", true, null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());

Applies to

GetEntry(String, Nullable<Boolean>, CancellationToken)

Source:
CodeTransparencyClient.cs

Get Entry with or without receipt embedded in its unprotected header.

public virtual Azure.Response<BinaryData> GetEntry (string entryId, bool? embedReceipt = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetEntry : string * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response<BinaryData>
override this.GetEntry : string * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response<BinaryData>
Public Overridable Function GetEntry (entryId As String, Optional embedReceipt As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of BinaryData)

Parameters

entryId
String

ID of the entry to retrieve.

embedReceipt
Nullable<Boolean>

Embed a receipt as part of the response.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Response<BinaryData>

Exceptions

ArgumentNullException

entryId is null.

ArgumentException

entryId is an empty string, and was expected to be non-empty.

Examples

This sample shows how to call GetEntry.

Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
CodeTransparencyClient client = new CodeTransparencyClient(endpoint, credential);

Response<BinaryData> response = client.GetEntry("<entryId>");

This sample shows how to call GetEntry with all parameters.

Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
CodeTransparencyClient client = new CodeTransparencyClient(endpoint, credential);

Response<BinaryData> response = client.GetEntry("<entryId>", embedReceipt: true);

Applies to