Microsoft.Attestation (stable:2018-09-01)

2025/09/26 • 9 new, 18 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 service instance ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation service instance. ,
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 ,
}
,
}

⚐ 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 or updates the 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 service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
creationParams:
{
Description: Client supplied parameters. ,
Required: True ,
}
{
location:
{
Description: The supported Azure location where the attestation service instance should be created. ,
Required: True ,
}
string ,
tags:
{
Description: The tags that will be assigned to the attestation service instance. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the attestation service instance ,
Required: True ,
}
{
attestationPolicy:
{
Description: Name of attestation policy. ,
Required: False ,
}
string ,
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)

{
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation service instance. ,
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 ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation service instance. ,
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 ,
}
,
}

⚐ 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 service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
updateParams:
{
Description: Client supplied parameters. ,
Required: True ,
}
{
tags:
{
Description: The tags that will be assigned to the attestation service instance. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation service instance. ,
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 ,
}
,
}

⚐ 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. ,
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 ,
}
,
}
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. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Attestation Provider array. ,
Required: False ,
}
[
{
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation service instance. ,
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 ,
}
,
}
,
]
,
}

⚐ 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. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Attestation Provider array. ,
Required: False ,
}
[
{
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation service instance. ,
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 ,
}
,
}
,
]
,
}

⚐ 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. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Attestation Provider array. ,
Required: False ,
}
[
{
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation service instance. ,
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 ,
}
,
}
,
]
,
}

⚐ 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. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation service instance. ,
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 ,
}
,
}

⚐ 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_PrepareToSet (removed)
Description :  Accepts a new policy document and returns a JWT which expresses used in preparation to set attestation policy.
Reference :  Link ¶

⚼ Request

POST:  /operations/policy/updatepolicy
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
tee:
{
Description: Specifies the trusted execution environment to be used to validate the evidence ,
Required: True ,
}
string ,
PolicyJws:
{
Description: JSON Web Signature (See RFC7515) expressing the new policy ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (400)

{
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 ,
}
,
}

⚐ Response (401)

{
$schema: 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_Get (removed)
Description :  Retrieves the current policy for a given kind of TEE.
Reference :  Link ¶

⚼ Request

GET:  /operations/policy/current
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
tee:
{
Description: Specifies the trusted execution environment to be used to validate the evidence ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
policy:
{
Description: JSON Web Token whose body is an AttestationPolicyRequest definition. ,
Required: False ,
}
string ,
}

⚐ Response (400)

{
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 ,
}
,
}

⚐ Response (401)

{
$schema: 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 kind of TEE.
Reference :  Link ¶

⚼ Request

PUT:  /operations/policy/current
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
tee:
{
Description: Specifies the trusted execution environment to be used to validate the evidence ,
Required: True ,
}
string ,
newAttestationPolicy:
{
Description: JWT Expressing the new policy ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (400)

{
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 ,
}
,
}

⚐ Response (401)

{
$schema: 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:  /operations/policy/current
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
tee:
{
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)

{
$schema: string ,
}

⚐ Response (400)

{
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 ,
}
,
}

⚐ Response (401)

{
$schema: 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:  /operations/policy/certificates
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (400)

{
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 ,
}
,
}

⚐ Response (401)

{
$schema: 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

PUT:  /operations/policy/certificates
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
policyCertificateToAdd:
{
Description: An RFC7519 JSON Web Token containing a claim named "maa-policyCertificate" whose value is an RFC7517 JSON Web Key which specifies a new key to add. The RFC7519 JWT must be signed with one of the existing signing certificates ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (400)

{
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 ,
}
,
}

⚐ Response (401)

{
$schema: 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:  /operations/policy/certificates
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
policyCertificateToRemove:
{
Description: An RFC7519 JSON Web Token containing a claim named "maa-policyCertificate" whose value is an RFC7517 JSON Web Key which specifies a new key to update. The RFC7519 JWT must be signed with one of the existing signing certificates ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (400)

{
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 ,
}
,
}

⚐ Response (401)

{
$schema: 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)

{
$schema: object ,
}

⚐ Response (400)

{
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 ,
}
,
}

⚐ 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 (400)

{
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 ,
}
,
}

⚐ 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 service instance ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation service instance. ,
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 ,
}
,
}

⚐ 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 or updates the 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 service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
creationParams:
{
Description: Client supplied parameters. ,
Required: True ,
}
{
location:
{
Description: The supported Azure location where the attestation service instance should be created. ,
Required: True ,
}
string ,
tags:
{
Description: The tags that will be assigned to the attestation service instance. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the attestation service instance ,
Required: True ,
}
{
attestationPolicy:
{
Description: Name of attestation policy. ,
Required: False ,
}
string ,
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)

{
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation service instance. ,
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 ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation service instance. ,
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 ,
}
,
}

⚐ 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 service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
updateParams:
{
Description: Client supplied parameters. ,
Required: True ,
}
{
tags:
{
Description: The tags that will be assigned to the attestation service instance. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation service instance. ,
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 ,
}
,
}

⚐ 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. ,
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 ,
}
,
}
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. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Attestation Provider array. ,
Required: False ,
}
[
{
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation service instance. ,
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 ,
}
,
}
,
]
,
}

⚐ 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. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Attestation Provider array. ,
Required: False ,
}
[
{
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation service instance. ,
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 ,
}
,
}
,
]
,
}

⚐ 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. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Attestation Provider array. ,
Required: False ,
}
[
{
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation service instance. ,
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 ,
}
,
}
,
]
,
}

⚐ 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. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Attestation service status. ,
Required: False ,
}
{
trustModel:
{
Description: Trust model for the attestation service instance. ,
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 ,
}
,
}

⚐ 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 ,
}
,
}