How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Appliances API

The Appliances API from Microsoft Azure — 11 operation(s) for appliances.

Microsoft Azure Appliances 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 Appliances. 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 20 operations across 11 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

20 operations 11 paths 29 schemas 3 DELETE9 GET3 PATCH2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 20

Across 11 paths, the API surfaces 20 operations — 3 DELETE, 9 GET, 3 PATCH, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Appliances 20
GET
/providers/Microsoft.ResourceConnector/operations
Microsoft Azure Get Providers Microsoft Resourceconnector Operations
microsoftAzureAppliancesListoperations 1 param → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.ResourceConnector/appliances
Microsoft Azure Gets A List Of Appliances In A Subscription
microsoftAzureAppliancesListbysubscription 2 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances
Microsoft Azure Gets A List Of Appliances In The Specified Subscription And Resource Group
microsoftAzureAppliancesListbyresourcegroup 3 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}
Microsoft Azure Gets An Appliance
microsoftAzureAppliancesGet 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}
Microsoft Azure Creates Or Updates An Appliance
microsoftAzureAppliancesCreateorupdate 4 params body → 200201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}
Microsoft Azure Deletes An Appliance
microsoftAzureAppliancesDelete 4 params → 202204default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}
Microsoft Azure Updates An Appliance
microsoftAzureAppliancesUpdate 4 params body → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}/listClusterCustomerUserCredential
Microsoft Azure Returns The Cluster Customer User Credential
microsoftAzureAppliancesListclustercustomerusercredential 4 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}/listClusterUserCredential
Microsoft Azure Returns The Cluster User Credential
microsoftAzureAppliancesListclusterusercredential 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}/upgradeGraphs/{upgradeGraph}
Microsoft Azure Gets An Appliance Upgrade Graph
microsoftAzureAppliancesGetupgradegraph 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/appliances/{applianceName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Solutions Appliances Appliancename
microsoftAzureAppliancesGet 4 params → 200404default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/appliances/{applianceName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Solutions Appliances Appliancename
microsoftAzureAppliancesDelete 4 params → 202204default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/appliances/{applianceName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Solutions Appliances Appliancename
microsoftAzureAppliancesCreateorupdate 4 params body → 200201default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/appliances/{applianceName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Solutions Appliances Appliancename
microsoftAzureAppliancesUpdate 4 params body → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/appliances
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Solutions Appliances
microsoftAzureAppliancesListbyresourcegroup 3 params → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.Solutions/appliances
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Solutions Appliances
microsoftAzureAppliancesListbysubscription 2 params → 200default
GET
/{applianceId}
Microsoft Azure Get Applianceid
microsoftAzureAppliancesGetbyid 2 params → 200404default
DELETE
/{applianceId}
Microsoft Azure Delete Applianceid
microsoftAzureAppliancesDeletebyid 2 params → 202204default
PUT
/{applianceId}
Microsoft Azure Put Applianceid
microsoftAzureAppliancesCreateorupdatebyid 2 params body → 200201default
PATCH
/{applianceId}
Microsoft Azure Patch Applianceid
microsoftAzureAppliancesUpdatebyid 2 params body → 200default

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are Sku (6 properties), ApplianceProperties (6 properties), applianceProperties (6 properties), Resource (5 properties). Each schema is shown below with its type and property counts.

ApplianceListResult
object
List of appliances.
2 properties
Plan
object
Plan for the appliance.
5 properties 4 required
appliance
object
Appliances definition.
3 properties
applianceListCredentialResults
object
The List Cluster User Credential appliance.
2 properties
HybridConnectionConfig
object
Contains the REP (rendezvous endpoint) and “Listener” access token from notification service (NS).
4 properties
applianceOperationsList
object
Lists of Appliances operations.
2 properties 1 required
Identity_2
object
Identity for the resource.
3 properties
applianceProperties
object
Properties for an appliance.
6 properties
ApplianceProperties
object
The appliance properties.
6 properties 1 required
Appliance
object
Information about appliance.
3 properties
Resource
object
Resource information.
5 properties
applianceCredentialKubeconfig
object
Cluster User Credential appliance.
2 properties
SSHKey
object
Appliance SSHKey definition.
2 properties
GenericResource
object
Resource information.
3 properties
applianceListResult
object
The List Appliances operation response.
2 properties
applianceOperation
object
Appliances operation.
4 properties
ProvisioningState
string
Provisioning status of the appliance.
Sku
object
SKU for the resource.
6 properties 1 required
UpgradeGraph
object
The Upgrade Graph for appliance.
3 properties
UpgradeGraphProperties
object
The Upgrade Graph Properties for appliance.
2 properties
SupportedVersion
object
The SupportedVersion object for appliance.
2 properties
applianceOperationValueDisplay
object
Describes the properties of an Appliances Operation Value Display.
4 properties
ErrorResponse
object
Error response indicates ARM appliance is not able to process the incoming request. The reason is provided in the error message.
3 properties
applianceListClusterCustomerUserCredentialResults
object
The List Cluster Customer User Credential Results appliance.
2 properties
SupportedVersionCatalogVersion
object
The SupportedVersionCatalogVersion object for appliance.
3 properties
SupportedVersionMetadata
object
The SupportedVersionMetadata object for appliance.
1 property
Identity
object
Identity for the resource.
3 properties
patchableAppliance
object
The Appliances patchable resource definition.
1 property
SupportedVersionCatalogVersionData
object
The SupportedVersionCatalogVersionData object for appliance.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-appliances-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Appliances API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.