@azure/arm-attestation package

Interfaces

AttestationManagementClientOptionalParams

Optional parameters for the client.

AttestationProvider

Attestation service response message.

AttestationProviderListResult

Attestation Providers List.

AttestationProvidersCreateOptionalParams

Optional parameters.

AttestationProvidersDeleteOptionalParams

Optional parameters.

AttestationProvidersGetDefaultByLocationOptionalParams

Optional parameters.

AttestationProvidersGetOptionalParams

Optional parameters.

AttestationProvidersListByResourceGroupOptionalParams

Optional parameters.

AttestationProvidersListDefaultOptionalParams

Optional parameters.

AttestationProvidersListOptionalParams

Optional parameters.

AttestationProvidersOperations

Interface representing a AttestationProviders operations.

AttestationProvidersUpdateOptionalParams

Optional parameters.

AttestationServiceCreationParams

Parameters for creating an attestation provider

AttestationServiceCreationSpecificParams

Client supplied parameters used to create a new attestation provider.

AttestationServicePatchParams

Parameters for patching an attestation provider

AttestationServicePatchSpecificParams

Client supplied parameters used to patch an existing attestation provider.

CloudError

An error response from Attestation.

CloudErrorBody

An error response from Attestation.

JsonWebKey

model interface JsonWebKey

JsonWebKeySet

model interface JsonWebKeySet

LogSpecification

Specifications of the Log for Microsoft Azure Attestation

OperationList

List of supported operations.

OperationProperties

Extra Operation properties

OperationsDefinition

Definition object with the name and properties of an operation.

OperationsDisplayDefinition

Display object with properties of the operation.

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

PrivateEndpoint

The private endpoint resource.

PrivateEndpointConnection

The Private Endpoint Connection resource.

PrivateEndpointConnectionProperties

Properties of the private endpoint connection.

PrivateEndpointConnectionsCreateOptionalParams

Optional parameters.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsListOptionalParams

Optional parameters.

PrivateEndpointConnectionsOperations

Interface representing a PrivateEndpointConnections operations.

PrivateLinkResource

A private link resource.

PrivateLinkResourceListResult

The response of a PrivateLinkResource list operation.

PrivateLinkResourceProperties

Properties of a private link resource.

PrivateLinkResourcesListByProviderOptionalParams

Optional parameters.

PrivateLinkResourcesOperations

Interface representing a PrivateLinkResources operations.

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

ServiceSpecification

Service specification payload

StatusResult

Status of attestation service.

SystemData

Metadata pertaining to creation and last modification of the resource.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Type Aliases

AttestationServiceStatus

Status of attestation service.
KnownAttestationServiceStatus can be used interchangeably with AttestationServiceStatus, this enum contains the known values that the service supports.

Known values supported by the service

Ready
NotReady
Error

AzureSupportedClouds

The supported values for cloud setting as a string literal type

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

PrivateEndpointConnectionProvisioningState

The current provisioning state.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Connection has been provisioned
Creating: Connection is being created
Deleting: Connection is being deleted
Failed: Connection provisioning has failed

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending: Connection waiting for approval or rejection
Approved: Connection approved
Rejected: Connection Rejected

PublicNetworkAccessType

The public network access type for API calls to the Attestation Provider.
KnownPublicNetworkAccessType can be used interchangeably with PublicNetworkAccessType, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Enables public network connectivity to the Attestation Provider REST APIs.
Disabled: Disables public network connectivity to the Attestation Provider REST APIs.

TpmAttestationAuthenticationType

The type for specifying the requirement of authentication for TPM Attestation REST APIs.
KnownTpmAttestationAuthenticationType can be used interchangeably with TpmAttestationAuthenticationType, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Enables the requirement of authentication for TPM Attestation REST APIs.
Disabled: Disables the requirement of authentication for TPM Attestation REST APIs.

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownAttestationServiceStatus

Status of attestation service.

KnownCreatedByType

The kind of entity that created the resource.

KnownPrivateEndpointConnectionProvisioningState

The current provisioning state.

KnownPrivateEndpointServiceConnectionStatus

The private endpoint connection status.

KnownPublicNetworkAccessType

The public network access type for API calls to the Attestation Provider.

KnownTpmAttestationAuthenticationType

The type for specifying the requirement of authentication for TPM Attestation REST APIs.

KnownVersions

The available API versions.

Functions

isRestError(unknown)

Typeguard for RestError

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type