Microsoft Azure Attestation Management Client is a tool designed to help users securely verify the authenticity and integrity of software running on virtual machines in the Azure cloud. By leveraging a combination of cryptographic techniques and hardware-based attestation technologies, the client can provide assurance that the software being executed has not been tampered with or compromised in any way.
swagger: '2.0'
info:
title: Microsoft Azure AttestationManagementClient
description: >-
Various APIs for managing resources in attestation service. This primarily
encompasses per-provider management.
version: 2021-06-01-preview
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
securityDefinitions:
azure_auth:
type: oauth2
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
flow: implicit
description: Azure Active Directory OAuth2 Flow
scopes:
user_impersonation: impersonate your user account
paths:
/providers/Microsoft.Attestation/operations:
get:
tags:
- Operations
operationId: microsoftAzureOperationsList
description: Lists all of the available Azure attestation operations.
x-ms-examples:
Operations_List:
$ref: ./examples/Operations_List.json
parameters:
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: List all the operations.
schema:
$ref: '#/definitions/OperationList'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: Microsoft Azure Get Providers Microsoft Attestation Operations
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}
: get:
tags:
- AttestationProviders
operationId: microsoftAzureAttestationprovidersGet
description: Get the status of Attestation Provider.
x-ms-examples:
AttestationProviders_Get:
$ref: ./examples/Get_AttestationProvider.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
- name: providerName
in: path
required: true
type: string
description: Name of the attestation provider.
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: The status of the specified attestation provider
schema:
$ref: '#/definitions/AttestationProvider'
default:
description: Error result from Attestation service
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Attestation Attestationproviders Providername
put:
tags:
- AttestationProviders
operationId: microsoftAzureAttestationprovidersCreate
description: Creates or updates an Attestation Provider.
x-ms-examples:
AttestationProviders_Create:
$ref: ./examples/Create_AttestationProvider.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
- name: providerName
in: path
required: true
type: string
description: Name of the attestation provider.
- $ref: '#/parameters/ApiVersionParameter'
- name: creationParams
in: body
required: true
description: Client supplied parameters.
schema:
$ref: '#/definitions/AttestationServiceCreationParams'
x-ms-parameter-location: method
responses:
'200':
description: Created or updated attestation service
schema:
$ref: '#/definitions/AttestationProvider'
'201':
description: Created or updated attestation service
schema:
$ref: '#/definitions/AttestationProvider'
default:
description: Error result from Attestation service
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Attestation Attestationproviders Providername
patch:
tags:
- AttestationProviders
operationId: microsoftAzureAttestationprovidersUpdate
description: Updates the Attestation Provider.
x-ms-examples:
AttestationProviders_Update:
$ref: ./examples/Update_AttestationProvider.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
- name: providerName
in: path
required: true
type: string
description: Name of the attestation provider.
- $ref: '#/parameters/ApiVersionParameter'
- name: updateParams
in: body
required: true
description: Client supplied parameters.
schema:
$ref: '#/definitions/AttestationServicePatchParams'
x-ms-parameter-location: method
responses:
'200':
description: Updated attestation service
schema:
$ref: '#/definitions/AttestationProvider'
default:
description: Error result from Attestation service
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Attestation Attestationproviders Providername
delete:
tags:
- AttestationProviders
operationId: microsoftAzureAttestationprovidersDelete
description: Delete Attestation Service.
x-ms-examples:
AttestationProviders_Delete:
$ref: ./examples/Delete_AttestationProvider.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
- name: providerName
in: path
required: true
type: string
description: Name of the attestation service
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: Resource exists and was deleted successfully
'202':
description: Request accepted for deletion of attestation service
'204':
description: Resource does not exist
default:
description: Error result from Attestation service
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Attestation Attestationproviders Providername
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}/privateEndpointConnections
: get:
tags:
- PrivateEndpointConnections
operationId: microsoftAzurePrivateendpointconnectionsList
description: >-
List all the private endpoint connections associated with the
attestation provider.
x-ms-examples:
AttestationProviderListPrivateEndpointConnections:
$ref: ./examples/AttestationProviderListPrivateEndpointConnections.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ProviderName'
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
responses:
'200':
description: OK -- Successfully retrieved private endpoint connections.
schema:
$ref: >-
../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnectionListResult
default:
description: Error result from Attestation service
schema:
$ref: '#/definitions/CloudError'
x-ms-pageable:
nextLinkName:
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Attestation Attestationproviders Providername Privateendpointconnections
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}/privateEndpointConnections/{privateEndpointConnectionName}
: get:
tags:
- PrivateEndpointConnections
operationId: microsoftAzurePrivateendpointconnectionsGet
description: >-
Gets the specified private endpoint connection associated with the
attestation provider.
x-ms-examples:
AttestationProviderGetPrivateEndpointConnection:
$ref: ./examples/AttestationProviderGetPrivateEndpointConnection.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ProviderName'
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName
responses:
'200':
description: OK -- Get the private endpoint connection properties successfully.
schema:
$ref: >-
../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Attestation Attestationproviders Providername Privateendpointconnections Privateendpointconnectionname
put:
tags:
- PrivateEndpointConnections
operationId: microsoftAzurePrivateendpointconnectionsCreate
description: >-
Update the state of specified private endpoint connection associated
with the attestation provider.
x-ms-examples:
AttestationProviderPutPrivateEndpointConnection:
$ref: ./examples/AttestationProviderPutPrivateEndpointConnection.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ProviderName'
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName
- name: properties
in: body
required: true
schema:
$ref: >-
../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection
description: The private endpoint connection properties.
responses:
'200':
description: >-
OK -- Update the private endpoint connection properties
successfully.
schema:
$ref: >-
../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Attestation Attestationproviders Providername Privateendpointconnections Privateendpointconnectionname
delete:
tags:
- PrivateEndpointConnections
operationId: microsoftAzurePrivateendpointconnectionsDelete
description: >-
Deletes the specified private endpoint connection associated with the
attestation provider.
x-ms-examples:
AttestationProviderDeletePrivateEndpointConnection:
$ref: ./examples/AttestationProviderDeletePrivateEndpointConnection.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ProviderName'
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName
responses:
'200':
description: OK -- Delete the private endpoint connection successfully.
'204':
description: No Content -- The private endpoint connection does not exist.
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Attestation Attestationproviders Providername Privateendpointconnections Privateendpointconnectionname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders/{providerName}/privateLinkResources
: get:
tags:
- PrivateLinkResources
operationId: microsoftAzurePrivatelinkresourcesListbyprovider
description: Gets the private link resources supported for the attestation provider.
x-ms-examples:
AttestationProviderListPrivateLinkResources:
$ref: ./examples/AttestationProviderListPrivateLinkResources.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ProviderName'
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
responses:
'200':
description: OK - Successfully retrieved private link resources.
schema:
$ref: >-
../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateLinkResourceListResult
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Attestation Attestationproviders Providername Privatelinkresources
/subscriptions/{subscriptionId}/providers/Microsoft.Attestation/attestationProviders:
get:
tags:
- AttestationProviders
operationId: microsoftAzureAttestationprovidersList
description: Returns a list of attestation providers in a subscription.
x-ms-examples:
AttestationProviders_List:
$ref: ./examples/Get_AttestationProvidersList.json
parameters:
- $ref: '#/parameters/ApiVersionParameter'
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/AttestationProviderListResult'
default:
description: Attestation service error result
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Attestation Attestationproviders
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Attestation/attestationProviders:
get:
tags:
- AttestationProviders
operationId: microsoftAzureAttestationprovidersListbyresourcegroup
description: Returns attestation providers list in a resource group.
x-ms-examples:
AttestationProviders_ListByResourceGroup:
$ref: ./examples/Get_AttestationProvidersListByResourceGroup.json
parameters:
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/ApiVersionParameter'
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/AttestationProviderListResult'
default:
description: Attestation service error result
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Attestation Attestationproviders
/subscriptions/{subscriptionId}/providers/Microsoft.Attestation/defaultProviders:
get:
tags:
- AttestationProviders
operationId: microsoftAzureAttestationprovidersListdefault
description: Get the default provider
x-ms-examples:
AttestationProviders_GetDefault:
$ref: ./examples/Get_DefaultProviders.json
parameters:
- $ref: '#/parameters/ApiVersionParameter'
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
responses:
'200':
description: Retrieved information about the default provider.
schema:
$ref: '#/definitions/AttestationProviderListResult'
default:
description: Attestation service error result
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Attestation Defaultproviders
/subscriptions/{subscriptionId}/providers/Microsoft.Attestation/locations/{location}/defaultProvider:
get:
tags:
- AttestationProviders
operationId: microsoftAzureAttestationprovidersGetdefaultbylocation
description: Get the default provider by location.
x-ms-examples:
AttestationProviders_GetDefaultWithLocation:
$ref: ./examples/Get_DefaultProviderByLocation.json
parameters:
- name: location
in: path
required: true
type: string
minLength: 1
description: The location of the default provider.
- $ref: '#/parameters/ApiVersionParameter'
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
responses:
'200':
description: Retrieved information about the default provider.
schema:
$ref: '#/definitions/AttestationProvider'
default:
description: Attestation service error result
schema:
$ref: '#/definitions/CloudError'
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Attestation Locations Location Defaultprovider
definitions:
OperationList:
properties:
systemData:
readOnly: true
description: The system metadata relating to this resource
$ref: >-
../../../../../common-types/resource-management/v1/types.json#/definitions/systemData
value:
type: array
description: List of supported operations.
items:
$ref: '#/definitions/OperationsDefinition'
description: List of supported operations.
OperationsDefinition:
type: object
description: Definition object with the name and properties of an operation.
properties:
name:
type: string
description: Name of the operation.
display:
$ref: '#/definitions/OperationsDisplayDefinition'
description: Display object with properties of the operation.
OperationsDisplayDefinition:
type: object
description: Display object with properties of the operation.
properties:
provider:
type: string
description: Resource provider of the operation.
resource:
type: string
description: Resource for the operation.
operation:
type: string
description: Short description of the operation.
description:
type: string
description: Description of the operation.
AttestationProvider:
description: Attestation service response message.
allOf:
- $ref: >-
../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource
properties:
systemData:
readOnly: true
description: The system metadata relating to this resource
$ref: >-
../../../../../common-types/resource-management/v1/types.json#/definitions/systemData
properties:
type: object
$ref: '#/definitions/StatusResult'
description: Describes Attestation service status.
x-ms-client-flatten: true
StatusResult:
type: object
description: Status of attestation service.
properties:
trustModel:
type: string
description: Trust model for the attestation provider.
status:
type: string
description: Status of attestation service.
enum:
- Ready
- NotReady
- Error
x-ms-enum:
name: AttestationServiceStatus
modelAsString: true
attestUri:
type: string
description: Gets the uri of attestation service
publicNetworkAccess:
description: >-
Controls whether traffic from the public network is allowed to access
the Attestation Provider APIs.
$ref: '#/definitions/PublicNetworkAccessType'
privateEndpointConnections:
readOnly: true
type: array
items:
$ref: >-
../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection
description: >-
List of private endpoint connections associated with the attestation
provider.
CloudError:
x-ms-external: true
properties:
error:
$ref: '#/definitions/CloudErrorBody'
description: An error response from Attestation.
CloudErrorBody:
x-ms-external: true
properties:
code:
type: string
description: >-
An identifier for the error. Codes are invariant and are intended to
be consumed programmatically.
message:
type: string
description: >-
A message describing the error, intended to be suitable for displaying
in a user interface.
description: An error response from Attestation.
AttestationProviderListResult:
description: Attestation Providers List.
properties:
systemData:
readOnly: true
description: The system metadata relating to this resource
$ref: >-
../../../../../common-types/resource-management/v1/types.json#/definitions/systemData
value:
type: array
description: Attestation Provider array.
items:
$ref: '#/definitions/AttestationProvider'
AttestationServicePatchParams:
description: Parameters for patching an attestation provider
x-ms-azure-resource: true
properties:
tags:
type: object
additionalProperties:
type: string
description: The tags that will be assigned to the attestation provider.
properties:
$ref: '#/definitions/AttestationServicePatchSpecificParams'
description: Properties of the attestation provider
AttestationServicePatchSpecificParams:
type: object
description: Client supplied parameters used to patch an existing attestation provider.
properties:
publicNetworkAccess:
description: >-
Controls whether traffic from the public network is allowed to access
the Attestation Provider APIs.
$ref: '#/definitions/PublicNetworkAccessType'
AttestationServiceCreationParams:
description: Parameters for creating an attestation provider
required:
- location
- properties
x-ms-azure-resource: true
properties:
location:
type: string
description: >-
The supported Azure location where the attestation provider should be
created.
tags:
type: object
additionalProperties:
type: string
description: The tags that will be assigned to the attestation provider.
properties:
$ref: '#/definitions/AttestationServiceCreationSpecificParams'
description: Properties of the attestation provider
AttestationServiceCreationSpecificParams:
description: Client supplied parameters used to create a new attestation provider.
properties:
publicNetworkAccess:
description: >-
Controls whether traffic from the public network is allowed to access
the Attestation Provider APIs.
$ref: '#/definitions/PublicNetworkAccessType'
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
$ref: >-
../../../../../common-types/rfcs/rfc7517.json#/definitions/JSONWebKeySet
PublicNetworkAccessType:
type: string
description: The public network access type for API calls to the Attestation Provider.
default: Enabled
enum:
- Enabled
- Disabled
x-ms-enum:
name: PublicNetworkAccessType
modelAsString: true
values:
- value: Enabled
description: >-
Enables public network connectivity to the Attestation Provider REST
APIs.
- value: Disabled
description: >-
Disables public network connectivity to the Attestation Provider
REST APIs.
parameters:
ApiVersionParameter:
name: api-version
in: query
required: true
type: string
description: Client API version. Current version is 2021-06-01-preview
PrivateEndpointConnectionName:
name: privateEndpointConnectionName
in: path
required: true
type: string
description: >-
Name of the private endpoint connection associated with the attestation
providers.
x-ms-parameter-location: method
ProviderName:
name: providerName
in: path
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
description: The name of the attestation provider.
x-ms-parameter-location: method
tags:
- name: AttestationProviders
- name: Operations
- name: PrivateEndpointConnections
- name: PrivateLinkResources