Microsoft.Attestation (stable:2020-10-01)

2025/09/26 • 13 new, 24 deleted methods

Operations_List (new)
Description :  Lists all of the available Azure attestation operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Attestation/operations
{
api-version:
{
Description: Client API version. Current version is 2020-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
value:
{
Description: List of supported operations. ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: Display object with properties of the operation. ,
Required: False ,
}
{
provider:
{
Description: Resource provider of the operation. ,
Required: False ,
}
string ,
resource:
{
Description: Resource for the operation. ,
Required: False ,
}
string ,
operation:
{
Description: Short description of the operation. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
AttestationProviders_Get (new)
Description :  Get the status of Attestation Provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: Name of the attestation provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. Current version is 2020-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation provider. ,
Required: False ,
}
string ,
status:
{
Description: Status of attestation service. ,
Enum:
{
Ready: No description available. ,
NotReady: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
attestUri:
{
Description: Gets the uri of attestation service ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the attestation provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
AttestationProviders_Create (new)
Description :  Creates a new Attestation Provider.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: Name of the attestation provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. Current version is 2020-10-01 ,
Required: True ,
}
string ,
creationParams:
{
Description: Client supplied parameters. ,
Required: True ,
}
{
location:
{
Description: The supported Azure location where the attestation provider should be created. ,
Required: True ,
}
string ,
tags:
{
Description: The tags that will be assigned to the attestation provider. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the attestation provider ,
Required: True ,
}
{
policySigningCertificates:
{
Description: JSON Web Key Set defining a set of X.509 Certificates that will represent the parent certificate for the signing certificate used for policy operations ,
Required: False ,
}
{
keys:
{
Description: The value of the "keys" parameter is an array of JWK values. By default, the order of the JWK values within the array does not imply an order of preference among them, although applications of JWK Sets can choose to assign a meaning to the order for their purposes, if desired. ,
Required: False ,
}
[
{
alg:
{
Description: The "alg" (algorithm) parameter identifies the algorithm intended for use with the key. The values used should either be registered in the IANA "JSON Web Signature and Encryption Algorithms" registry established by [JWA] or be a value that contains a Collision- Resistant Name. ,
Required: False ,
}
string ,
crv:
{
Description: The "crv" (curve) parameter identifies the curve type ,
Required: False ,
}
string ,
d:
{
Description: RSA private exponent or ECC private key ,
Required: False ,
}
string ,
dp:
{
Description: RSA Private Key Parameter ,
Required: False ,
}
string ,
dq:
{
Description: RSA Private Key Parameter ,
Required: False ,
}
string ,
e:
{
Description: RSA public exponent, in Base64 ,
Required: False ,
}
string ,
k:
{
Description: Symmetric key ,
Required: False ,
}
string ,
kid:
{
Description: The "kid" (key ID) parameter is used to match a specific key. This is used, for instance, to choose among a set of keys within a JWK Set during key rollover. The structure of the "kid" value is unspecified. When "kid" values are used within a JWK Set, different keys within the JWK Set SHOULD use distinct "kid" values. (One example in which different keys might use the same "kid" value is if they have different "kty" (key type) values but are considered to be equivalent alternatives by the application using them.) The "kid" value is a case-sensitive string. ,
Required: False ,
}
string ,
kty:
{
Description: The "kty" (key type) parameter identifies the cryptographic algorithm family used with the key, such as "RSA" or "EC". "kty" values should either be registered in the IANA "JSON Web Key Types" registry established by [JWA] or be a value that contains a Collision- Resistant Name. The "kty" value is a case-sensitive string. ,
Required: True ,
}
string ,
n:
{
Description: RSA modulus, in Base64 ,
Required: False ,
}
string ,
p:
{
Description: RSA secret prime ,
Required: False ,
}
string ,
q:
{
Description: RSA secret prime, with p < q ,
Required: False ,
}
string ,
qi:
{
Description: RSA Private Key Parameter ,
Required: False ,
}
string ,
use:
{
Description: Use ("public key use") identifies the intended use of the public key. The "use" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Values are commonly "sig" (signature) or "enc" (encryption). ,
Required: False ,
}
string ,
x:
{
Description: X coordinate for the Elliptic Curve point ,
Required: False ,
}
string ,
x5c:
{
Description: The "x5c" (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates [RFC5280]. The certificate chain is represented as a JSON array of certificate value strings. Each string in the array is a base64-encoded (Section 4 of [RFC4648] -- not base64url-encoded) DER [ITU.X690.1994] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate. ,
Required: False ,
}
[
string ,
]
,
y:
{
Description: Y coordinate for the Elliptic Curve point ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation provider. ,
Required: False ,
}
string ,
status:
{
Description: Status of attestation service. ,
Enum:
{
Ready: No description available. ,
NotReady: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
attestUri:
{
Description: Gets the uri of attestation service ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the attestation provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation provider. ,
Required: False ,
}
string ,
status:
{
Description: Status of attestation service. ,
Enum:
{
Ready: No description available. ,
NotReady: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
attestUri:
{
Description: Gets the uri of attestation service ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the attestation provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
AttestationProviders_Update (new)
Description :  Updates the Attestation Provider.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: Name of the attestation provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. Current version is 2020-10-01 ,
Required: True ,
}
string ,
updateParams:
{
Description: Client supplied parameters. ,
Required: True ,
}
{
tags:
{
Description: The tags that will be assigned to the attestation provider. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation provider. ,
Required: False ,
}
string ,
status:
{
Description: Status of attestation service. ,
Enum:
{
Ready: No description available. ,
NotReady: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
attestUri:
{
Description: Gets the uri of attestation service ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the attestation provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
AttestationProviders_Delete (new)
Description :  Delete Attestation Service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: Name of the attestation service ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. Current version is 2020-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_List (new)
Description :  List all the private endpoint connections associated with the attestation provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}/privateEndpointConnections
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: The name of the attestation provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Gets the specified private endpoint connection associated with the attestation provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: The name of the attestation provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_Create (new)
Description :  Update the state of specified private endpoint connection associated with the attestation provider.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: The name of the attestation provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes the specified private endpoint connection associated with the attestation provider.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: The name of the attestation provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
AttestationProviders_List (new)
Description :  Returns a list of attestation providers in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Attestation/attestationProviders
{
api-version:
{
Description: Client API version. Current version is 2020-10-01 ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
value:
{
Description: Attestation Provider array. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation provider. ,
Required: False ,
}
string ,
status:
{
Description: Status of attestation service. ,
Enum:
{
Ready: No description available. ,
NotReady: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
attestUri:
{
Description: Gets the uri of attestation service ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the attestation provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
AttestationProviders_ListByResourceGroup (new)
Description :  Returns attestation providers list in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. Current version is 2020-10-01 ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
value:
{
Description: Attestation Provider array. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation provider. ,
Required: False ,
}
string ,
status:
{
Description: Status of attestation service. ,
Enum:
{
Ready: No description available. ,
NotReady: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
attestUri:
{
Description: Gets the uri of attestation service ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the attestation provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
AttestationProviders_ListDefault (new)
Description :  Get the default provider
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Attestation/defaultProviders
{
api-version:
{
Description: Client API version. Current version is 2020-10-01 ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
value:
{
Description: Attestation Provider array. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation provider. ,
Required: False ,
}
string ,
status:
{
Description: Status of attestation service. ,
Enum:
{
Ready: No description available. ,
NotReady: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
attestUri:
{
Description: Gets the uri of attestation service ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the attestation provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
AttestationProviders_GetDefaultByLocation (new)
Description :  Get the default provider by location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Attestation/locations/{location}/defaultProvider
{
location:
{
Description: The location of the default provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. Current version is 2020-10-01 ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation provider. ,
Required: False ,
}
string ,
status:
{
Description: Status of attestation service. ,
Enum:
{
Ready: No description available. ,
NotReady: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
attestUri:
{
Description: Gets the uri of attestation service ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the attestation provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
Policy_Get (removed)
Description :  Retrieves the current policy for an attestation type.
Reference :  Link ¶

⚼ Request

GET:  /policies/{attestationType}
{
api-version:
{
Description: Client API version. Current version is 2010-10-01 ,
Required: True ,
}
string ,
attestationType:
{
Description: Specifies the trusted execution environment to be used to validate the evidence ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
token:
{
Description: An RFC7519 JSON Web Token structure whose body is an PolicyResult object. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
Policy_Set (removed)
Description :  Sets the policy for a given attestation type.
Reference :  Link ¶

⚼ Request

PUT:  /policies/{attestationType}
{
api-version:
{
Description: Client API version. Current version is 2010-10-01 ,
Required: True ,
}
string ,
attestationType:
{
Description: Specifies the trusted execution environment to be used to validate the evidence ,
Required: True ,
}
string ,
newAttestationPolicy:
{
Description: JWT Expressing the new policy whose body is a StoredAttestationPolicy object. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
token:
{
Description: An RFC7519 JSON Web Token structure whose body is an PolicyResult object. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
Policy_Reset (removed)
Description :  Resets the attestation policy for the specified tenant and reverts to the default policy.
Reference :  Link ¶

⚼ Request

POST:  /policies/{attestationType}:reset
{
api-version:
{
Description: Client API version. Current version is 2010-10-01 ,
Required: True ,
}
string ,
attestationType:
{
Description: Specifies the trusted execution environment to be used to validate the evidence ,
Required: True ,
}
string ,
PolicyJws:
{
Description: JSON Web Signature with an empty policy document ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
token:
{
Description: An RFC7519 JSON Web Token structure whose body is an PolicyResult object. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
PolicyCertificates_Get (removed)
Description :  Retrieves the set of certificates used to express policy for the current tenant.
Reference :  Link ¶

⚼ Request

GET:  /certificates
{
api-version:
{
Description: Client API version. Current version is 2010-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
token:
{
Description: An RFC7519 JSON Web Token structure containing a PolicyCertificatesResults object which contains the certificates used to validate policy changes ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
PolicyCertificates_Add (removed)
Description :  Adds a new attestation policy certificate to the set of policy management certificates.
Reference :  Link ¶

⚼ Request

POST:  /certificates:add
{
api-version:
{
Description: Client API version. Current version is 2010-10-01 ,
Required: True ,
}
string ,
policyCertificateToAdd:
{
Description: An RFC7519 JSON Web Token whose body is an RFC7517 JSON Web Key object. The RFC7519 JWT must be signed with one of the existing signing certificates ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
token:
{
Description: An RFC7519 JSON Web Token structure whose body is a PolicyCertificatesModificationResult object. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
PolicyCertificates_Remove (removed)
Description :  Removes the specified policy management certificate. Note that the final policy management certificate cannot be removed.
Reference :  Link ¶

⚼ Request

POST:  /certificates:remove
{
api-version:
{
Description: Client API version. Current version is 2010-10-01 ,
Required: True ,
}
string ,
policyCertificateToRemove:
{
Description: An RFC7519 JSON Web Token whose body is an AttestationCertificateManagementBody object. The RFC7519 JWT must be signed with one of the existing signing certificates ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
token:
{
Description: An RFC7519 JSON Web Token structure whose body is a PolicyCertificatesModificationResult object. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
Attestation_AttestOpenEnclave (removed)
Description :  Processes an OpenEnclave report , producing an artifact. The type of artifact produced is dependent upon attestation policy.
Reference :  Link ¶

⚼ Request

POST:  /attest/OpenEnclave
{
api-version:
{
Description: Client API version. Current version is 2010-10-01 ,
Required: True ,
}
string ,
request:
{
Description: Request object containing the quote ,
Required: True ,
}
{
report:
{
Description: OpenEnclave report from the enclave to be attested ,
Format: base64url ,
Required: False ,
}
string ,
runtimeData:
{
Description: Runtime data provided by the enclave at the time of report generation. The MAA will verify that the first 32 bytes of the report_data field of the quote contains the SHA256 hash of the decoded "data" field of the runtime data. ,
Required: False ,
}
{
data:
{
Description: Runtime data are generated by the Trusted Execution Environment (TEE). For an SGX quote (Coffeelake or Icelake), the SHA256 hash of the RuntimeData must match the lower 32 bytes of the quote's "report data" attribute. For a SEV-SNP quote, the SHA256 hash of the RuntimeData must match the quote's "report data" attribute. ,
Format: base64url ,
Required: False ,
}
string ,
dataType:
{
Description: The type of data contained within the "data" field ,
Enum:
{
Binary: The field's content should be treated as binary and not interpreted by MAA. ,
JSON: The field's content should be treated as UTF-8 JSON text that may be further interpreted by MAA. Refer to RFC 8259 for a description of JSON serialization standards for interoperability. ,
}
,
Required: False ,
}
enum ,
}
,
initTimeData:
{
Description: Base64Url encoded "InitTime data". The MAA will verify that the init data was known to the enclave. Note that InitTimeData is invalid for CoffeeLake processors. ,
Required: False ,
}
{
data:
{
Description: Initialization time data are passed into the Trusted Execution Environment (TEE) when it is created. For an Icelake SGX quote, the SHA256 hash of the InitTimeData must match the lower 32 bytes of the quote's "config id" attribute. For a SEV-SNP quote, the SHA256 hash of the InitTimeData must match the quote's "host data" attribute. ,
Format: base64url ,
Required: False ,
}
string ,
dataType:
{
Description: The type of data contained within the "data" field ,
Enum:
{
Binary: The field's content should be treated as binary and not interpreted by MAA. ,
JSON: The field's content should be treated as UTF-8 JSON text that may be further interpreted by MAA. Refer to RFC 8259 for a description of JSON serialization standards for interoperability. ,
}
,
Required: False ,
}
enum ,
}
,
draftPolicyForAttestation:
{
Description: Attest against the provided draft policy. Note that the resulting token cannot be validated. ,
Required: False ,
}
string ,
nonce:
{
Description: Nonce for incoming request - emitted in the generated attestation token ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
token:
{
Description: An RFC 7519 JSON Web Token, the body of which is an AttestationResult object. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
Attestation_AttestSgxEnclave (removed)
Description :  Processes an SGX enclave quote, producing an artifact. The type of artifact produced is dependent upon attestation policy.
Reference :  Link ¶

⚼ Request

POST:  /attest/SgxEnclave
{
api-version:
{
Description: Client API version. Current version is 2010-10-01 ,
Required: True ,
}
string ,
request:
{
Description: Request object containing the quote ,
Required: True ,
}
{
quote:
{
Description: Quote of the enclave to be attested ,
Format: base64url ,
Required: False ,
}
string ,
runtimeData:
{
Description: Runtime data provided by the enclave at the time of quote generation. The MAA will verify that the first 32 bytes of the report_data field of the quote contains the SHA256 hash of the decoded "data" field of the runtime data. ,
Required: False ,
}
{
data:
{
Description: Runtime data are generated by the Trusted Execution Environment (TEE). For an SGX quote (Coffeelake or Icelake), the SHA256 hash of the RuntimeData must match the lower 32 bytes of the quote's "report data" attribute. For a SEV-SNP quote, the SHA256 hash of the RuntimeData must match the quote's "report data" attribute. ,
Format: base64url ,
Required: False ,
}
string ,
dataType:
{
Description: The type of data contained within the "data" field ,
Enum:
{
Binary: The field's content should be treated as binary and not interpreted by MAA. ,
JSON: The field's content should be treated as UTF-8 JSON text that may be further interpreted by MAA. Refer to RFC 8259 for a description of JSON serialization standards for interoperability. ,
}
,
Required: False ,
}
enum ,
}
,
initTimeData:
{
Description: Initialization data provided when the enclave is created. MAA will verify that the init data was known to the enclave. Note that InitTimeData is invalid for CoffeeLake processors. ,
Required: False ,
}
{
data:
{
Description: Initialization time data are passed into the Trusted Execution Environment (TEE) when it is created. For an Icelake SGX quote, the SHA256 hash of the InitTimeData must match the lower 32 bytes of the quote's "config id" attribute. For a SEV-SNP quote, the SHA256 hash of the InitTimeData must match the quote's "host data" attribute. ,
Format: base64url ,
Required: False ,
}
string ,
dataType:
{
Description: The type of data contained within the "data" field ,
Enum:
{
Binary: The field's content should be treated as binary and not interpreted by MAA. ,
JSON: The field's content should be treated as UTF-8 JSON text that may be further interpreted by MAA. Refer to RFC 8259 for a description of JSON serialization standards for interoperability. ,
}
,
Required: False ,
}
enum ,
}
,
draftPolicyForAttestation:
{
Description: Attest against the provided draft policy. Note that the resulting token cannot be validated. ,
Required: False ,
}
string ,
nonce:
{
Description: Nonce for incoming request - emitted in the generated attestation token ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
token:
{
Description: An RFC 7519 JSON Web Token, the body of which is an AttestationResult object. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
Attestation_AttestTpm (removed)
Description :  Processes attestation evidence from a VBS enclave, producing an attestation result. The attestation result produced is dependent upon the attestation policy.
Reference :  Link ¶

⚼ Request

POST:  /attest/Tpm
{
api-version:
{
Description: Client API version. Current version is 2010-10-01 ,
Required: True ,
}
string ,
request:
{
Description: Request object ,
Required: True ,
}
{
data:
{
Description: Protocol data containing artifacts for attestation. ,
Format: base64url ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
data:
{
Description: Protocol data containing attestation service response. ,
Format: base64url ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
SigningCertificates_Get (removed)
Description :  Retrieves metadata signing certificates in use by the attestation service
Reference :  Link ¶

⚼ Request

GET:  /certs
{}

⚐ Response (200)

{
keys:
{
Description: The value of the "keys" parameter is an array of JWK values. By default, the order of the JWK values within the array does not imply an order of preference among them, although applications of JWK Sets can choose to assign a meaning to the order for their purposes, if desired. ,
Required: False ,
}
[
{
alg:
{
Description: The "alg" (algorithm) parameter identifies the algorithm intended for use with the key. The values used should either be registered in the IANA "JSON Web Signature and Encryption Algorithms" registry established by [JWA] or be a value that contains a Collision- Resistant Name. ,
Required: False ,
}
string ,
crv:
{
Description: The "crv" (curve) parameter identifies the curve type ,
Required: False ,
}
string ,
d:
{
Description: RSA private exponent or ECC private key ,
Required: False ,
}
string ,
dp:
{
Description: RSA Private Key Parameter ,
Required: False ,
}
string ,
dq:
{
Description: RSA Private Key Parameter ,
Required: False ,
}
string ,
e:
{
Description: RSA public exponent, in Base64 ,
Required: False ,
}
string ,
k:
{
Description: Symmetric key ,
Required: False ,
}
string ,
kid:
{
Description: The "kid" (key ID) parameter is used to match a specific key. This is used, for instance, to choose among a set of keys within a JWK Set during key rollover. The structure of the "kid" value is unspecified. When "kid" values are used within a JWK Set, different keys within the JWK Set SHOULD use distinct "kid" values. (One example in which different keys might use the same "kid" value is if they have different "kty" (key type) values but are considered to be equivalent alternatives by the application using them.) The "kid" value is a case-sensitive string. ,
Required: False ,
}
string ,
kty:
{
Description: The "kty" (key type) parameter identifies the cryptographic algorithm family used with the key, such as "RSA" or "EC". "kty" values should either be registered in the IANA "JSON Web Key Types" registry established by [JWA] or be a value that contains a Collision- Resistant Name. The "kty" value is a case-sensitive string. ,
Required: True ,
}
string ,
n:
{
Description: RSA modulus, in Base64 ,
Required: False ,
}
string ,
p:
{
Description: RSA secret prime ,
Required: False ,
}
string ,
q:
{
Description: RSA secret prime, with p < q ,
Required: False ,
}
string ,
qi:
{
Description: RSA Private Key Parameter ,
Required: False ,
}
string ,
use:
{
Description: Use ("public key use") identifies the intended use of the public key. The "use" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Values are commonly "sig" (signature) or "enc" (encryption). ,
Required: False ,
}
string ,
x:
{
Description: X coordinate for the Elliptic Curve point ,
Required: False ,
}
string ,
x5c:
{
Description: The "x5c" (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates [RFC5280]. The certificate chain is represented as a JSON array of certificate value strings. Each string in the array is a base64-encoded (Section 4 of [RFC4648] -- not base64url-encoded) DER [ITU.X690.1994] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate. ,
Required: False ,
}
[
string ,
]
,
y:
{
Description: Y coordinate for the Elliptic Curve point ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
MetadataConfiguration_Get (removed)
Description :  Retrieves metadata about the attestation signing keys in use by the attestation service
Reference :  Link ¶

⚼ Request

GET:  /.well-known/openid-configuration
{}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  Lists all of the available Azure attestation operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Attestation/operations
{
api-version:
{
Description: Client API version. Current version is 2020-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
value:
{
Description: List of supported operations. ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: Display object with properties of the operation. ,
Required: False ,
}
{
provider:
{
Description: Resource provider of the operation. ,
Required: False ,
}
string ,
resource:
{
Description: Resource for the operation. ,
Required: False ,
}
string ,
operation:
{
Description: Short description of the operation. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
AttestationProviders_Get (removed)
Description :  Get the status of Attestation Provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: Name of the attestation provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. Current version is 2020-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation provider. ,
Required: False ,
}
string ,
status:
{
Description: Status of attestation service. ,
Enum:
{
Ready: No description available. ,
NotReady: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
attestUri:
{
Description: Gets the uri of attestation service ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the attestation provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
AttestationProviders_Create (removed)
Description :  Creates a new Attestation Provider.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: Name of the attestation provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. Current version is 2020-10-01 ,
Required: True ,
}
string ,
creationParams:
{
Description: Client supplied parameters. ,
Required: True ,
}
{
location:
{
Description: The supported Azure location where the attestation provider should be created. ,
Required: True ,
}
string ,
tags:
{
Description: The tags that will be assigned to the attestation provider. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the attestation provider ,
Required: True ,
}
{
policySigningCertificates:
{
Description: JSON Web Key Set defining a set of X.509 Certificates that will represent the parent certificate for the signing certificate used for policy operations ,
Required: False ,
}
{
keys:
{
Description: The value of the "keys" parameter is an array of JWK values. By default, the order of the JWK values within the array does not imply an order of preference among them, although applications of JWK Sets can choose to assign a meaning to the order for their purposes, if desired. ,
Required: False ,
}
[
{
alg:
{
Description: The "alg" (algorithm) parameter identifies the algorithm intended for use with the key. The values used should either be registered in the IANA "JSON Web Signature and Encryption Algorithms" registry established by [JWA] or be a value that contains a Collision- Resistant Name. ,
Required: False ,
}
string ,
crv:
{
Description: The "crv" (curve) parameter identifies the curve type ,
Required: False ,
}
string ,
d:
{
Description: RSA private exponent or ECC private key ,
Required: False ,
}
string ,
dp:
{
Description: RSA Private Key Parameter ,
Required: False ,
}
string ,
dq:
{
Description: RSA Private Key Parameter ,
Required: False ,
}
string ,
e:
{
Description: RSA public exponent, in Base64 ,
Required: False ,
}
string ,
k:
{
Description: Symmetric key ,
Required: False ,
}
string ,
kid:
{
Description: The "kid" (key ID) parameter is used to match a specific key. This is used, for instance, to choose among a set of keys within a JWK Set during key rollover. The structure of the "kid" value is unspecified. When "kid" values are used within a JWK Set, different keys within the JWK Set SHOULD use distinct "kid" values. (One example in which different keys might use the same "kid" value is if they have different "kty" (key type) values but are considered to be equivalent alternatives by the application using them.) The "kid" value is a case-sensitive string. ,
Required: False ,
}
string ,
kty:
{
Description: The "kty" (key type) parameter identifies the cryptographic algorithm family used with the key, such as "RSA" or "EC". "kty" values should either be registered in the IANA "JSON Web Key Types" registry established by [JWA] or be a value that contains a Collision- Resistant Name. The "kty" value is a case-sensitive string. ,
Required: True ,
}
string ,
n:
{
Description: RSA modulus, in Base64 ,
Required: False ,
}
string ,
p:
{
Description: RSA secret prime ,
Required: False ,
}
string ,
q:
{
Description: RSA secret prime, with p < q ,
Required: False ,
}
string ,
qi:
{
Description: RSA Private Key Parameter ,
Required: False ,
}
string ,
use:
{
Description: Use ("public key use") identifies the intended use of the public key. The "use" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Values are commonly "sig" (signature) or "enc" (encryption). ,
Required: False ,
}
string ,
x:
{
Description: X coordinate for the Elliptic Curve point ,
Required: False ,
}
string ,
x5c:
{
Description: The "x5c" (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates [RFC5280]. The certificate chain is represented as a JSON array of certificate value strings. Each string in the array is a base64-encoded (Section 4 of [RFC4648] -- not base64url-encoded) DER [ITU.X690.1994] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate. ,
Required: False ,
}
[
string ,
]
,
y:
{
Description: Y coordinate for the Elliptic Curve point ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation provider. ,
Required: False ,
}
string ,
status:
{
Description: Status of attestation service. ,
Enum:
{
Ready: No description available. ,
NotReady: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
attestUri:
{
Description: Gets the uri of attestation service ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the attestation provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation provider. ,
Required: False ,
}
string ,
status:
{
Description: Status of attestation service. ,
Enum:
{
Ready: No description available. ,
NotReady: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
attestUri:
{
Description: Gets the uri of attestation service ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the attestation provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
AttestationProviders_Update (removed)
Description :  Updates the Attestation Provider.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: Name of the attestation provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. Current version is 2020-10-01 ,
Required: True ,
}
string ,
updateParams:
{
Description: Client supplied parameters. ,
Required: True ,
}
{
tags:
{
Description: The tags that will be assigned to the attestation provider. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation provider. ,
Required: False ,
}
string ,
status:
{
Description: Status of attestation service. ,
Enum:
{
Ready: No description available. ,
NotReady: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
attestUri:
{
Description: Gets the uri of attestation service ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the attestation provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
AttestationProviders_Delete (removed)
Description :  Delete Attestation Service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: Name of the attestation service ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. Current version is 2020-10-01 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_List (removed)
Description :  List all the private endpoint connections associated with the attestation provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}/privateEndpointConnections
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: The name of the attestation provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_Get (removed)
Description :  Gets the specified private endpoint connection associated with the attestation provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: The name of the attestation provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_Create (removed)
Description :  Update the state of specified private endpoint connection associated with the attestation provider.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: The name of the attestation provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_Delete (removed)
Description :  Deletes the specified private endpoint connection associated with the attestation provider.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerName:
{
Description: The name of the attestation provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
AttestationProviders_List (removed)
Description :  Returns a list of attestation providers in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Attestation/attestationProviders
{
api-version:
{
Description: Client API version. Current version is 2020-10-01 ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
value:
{
Description: Attestation Provider array. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation provider. ,
Required: False ,
}
string ,
status:
{
Description: Status of attestation service. ,
Enum:
{
Ready: No description available. ,
NotReady: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
attestUri:
{
Description: Gets the uri of attestation service ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the attestation provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
AttestationProviders_ListByResourceGroup (removed)
Description :  Returns attestation providers list in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. Current version is 2020-10-01 ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
value:
{
Description: Attestation Provider array. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation provider. ,
Required: False ,
}
string ,
status:
{
Description: Status of attestation service. ,
Enum:
{
Ready: No description available. ,
NotReady: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
attestUri:
{
Description: Gets the uri of attestation service ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the attestation provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
AttestationProviders_ListDefault (removed)
Description :  Get the default provider
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Attestation/defaultProviders
{
api-version:
{
Description: Client API version. Current version is 2020-10-01 ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
value:
{
Description: Attestation Provider array. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation provider. ,
Required: False ,
}
string ,
status:
{
Description: Status of attestation service. ,
Enum:
{
Ready: No description available. ,
NotReady: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
attestUri:
{
Description: Gets the uri of attestation service ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the attestation provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}
AttestationProviders_GetDefaultByLocation (removed)
Description :  Get the default provider by location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Attestation/locations/{location}/defaultProvider
{
location:
{
Description: The location of the default provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. Current version is 2020-10-01 ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata relating to this resource ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation provider. ,
Required: False ,
}
string ,
status:
{
Description: Status of attestation service. ,
Enum:
{
Ready: No description available. ,
NotReady: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
attestUri:
{
Description: Gets the uri of attestation service ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: List of private endpoint connections associated with the attestation provider. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from Attestation. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
}
,
}