Microsoft Azure Gov API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Gov. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.
This API exposes
23 operations
across 23 paths,
and defines 47 schemas.
It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.
The identity and technical contract details declared by the specification.
Proposals.ProposalState
string
Possible states for a proposal.
ServiceState.MemberStatus
string
Possible states for a CCF governing member.
Proposals.VoteFailures
object
Each key is a memberId, and the corresponding value explains why execution of their ballot failed.
Azure.Core.Foundations.Error
object
The error object.
5 properties
2 required
ServiceState.QuoteInfo
object
Common type for attestation information, describing the cryptographically-endorsed claim of what code is executing, and what platform it is executing on. Deriv…
1 property
1 required
Acks.StateDigest
object
A compact summary of the service's state up to a certain point in time, updated and signed by members to indicate their participation in and approval of the se…
1 property
1 required
Proposals.Ballot
object
The source script of an executable vote from a member, regarding a proposed change to the service.
1 property
1 required
Proposals.Action
object
A single step in a proposed change to the service.
2 properties
1 required
ServiceState.JoinPolicies
object
Collection of all policies which determine currently acceptable nodes, across multiple platforms.
2 properties
2 required
nodeId
string
Hex encoding of SHA-256 of a node's public key.
ServiceState.ForwardingRequired
string
Describes the forwarding behavior of a specific endpoint. Write requests cannot be executed on a backup, so will generally be forwarded by any backup node whic…
ServiceState.pem
string
PEM encoding of a cryptographic identifier. Contains a base64-encoded payload wrapped in content type identifiers.
ServiceState.JsEndpointInfo
object
Describes an endpoint implemented by a Javascript handler.
6 properties
6 required
Recovery.RecoveryResponse
object
Response to a submitted recovery share.
3 properties
3 required
ServiceState.JsOperations
object
The collection of operations available on each path. Keyed by HTTP method.
Transactions.Transaction
object
Common transaction information.
1 property
1 required
Proposals.MemberVotes
object
Each key is a memberId, and the corresponding value is the result of their ballot.
ServiceState.SnpJoinPolicy
object
Join policy fields specific to nodes running on AMD SEV-SNP hardware.
3 properties
3 required
Azure.Core.Foundations.InnerError
object
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Gu…
2 properties
ServiceState.ServiceStatus
string
State machine values for current service lifetime. New services start in Opening, and transition to Open via a governance proposal. They will only accept user…
transactionId
string
Uniquely identifies an atomic transaction within a CCF service. Composed of a term number and sequence number. Sequence numbers increase monotonically, apart f…
Proposals.ProposalActions
object
The actions contained in a proposal, describing the proposal's changes.
1 property
1 required
Transactions.TransactionStatus
string
Possible states for a CCF transaction. See docs for details: https://microsoft.github.io/CCF/main/useapps/verifytx.htmlchecking-for-commit
ServiceState.NodeStatus
string
Lifecycle state of a CCF node. Nodes will generally start as Pending, then transition to Trusted, then to Retired. They are only full participants in the servi…
proposalId
string
Hex encoding of SHA-256 of proposed actions and merkle root of store at proposal creation. Unlike other IDs, this is generated on the service and will not be k…
ServiceState.JwtIssuerKeyFilter
string
Possible restrictions on what keys will be accepted from a JWT issuer.
ServiceState.ServiceInfo
object
General information about the current service.
7 properties
5 required
ServiceState.caCertBundle
string
Chain of endorsed certificates (PEM format) leading to a CA.
PagedNode
object
Paged collection of Node items
2 properties
1 required
Recovery.EncryptedRecoveryShare
object
A share of a recovery key, granted for a specific recovery member, and encrypted with that member's share-encryption key. This is safe to share in the ledger o…
1 property
1 required
ServiceState.JsExecMode
string
Describes the execution requirements of a specific endpoint.
Proposals.FailureInfo
object
Description of why governance execution failed.
2 properties
1 required
safeuint
integer
A non-negative JSON-safe integer (ie max is 2^53 - 1)
Azure.Core.Foundations.ErrorResponse
object
A response containing error details.
1 property
1 required
ServiceState.ConstitutionResponse
object
Constitution used to make governance decisions on the service. All governance changes are presented as proposals which must be validated, approved, and applied…
1 property
1 required
ServiceState.JoinPolicy
object
Describes what a joining node must present, in order to join the service.
1 property
1 required
Proposals.Proposal
object
Description of a proposed change to the service.
7 properties
4 required
ServiceState.JwtIssuer
object
Description of a JWT issuer or identity provider that the current service will trust tokens from.
4 properties
2 required
PagedMember
object
Paged collection of Member items
2 properties
1 required
ServiceState.Node
object
Information on individual nodes within a service.
7 properties
6 required
ServiceState.JwkInfo
object
Describes what Javascript Web Tokens (JWTs) are accepted by the service, and how they will be validated.
2 properties
2 required
ServiceState.Member
object
Information on individual members within a consortium.
4 properties
3 required
memberId
string
Hex encoding of SHA-256 of a member certificate's fingerprint.
PagedProposal
object
Paged collection of Proposal items
2 properties
1 required
ServiceState.JsApp
object
Describes the currently installed JavaScript application.
1 property
1 required
ServiceState.NetworkInterface
object
Details of how to contact a CCF node. Each node may listen on multiple interfaces, for different kinds of traffic.
2 properties
2 required
Transactions.CommittedTransaction
object
Description of latest committed transaction.
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Microsoft Azure publishes across the network.
