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 DeploymentSettings API

The DeploymentSettings API from Microsoft Azure — 2 operation(s) for deploymentsettings.

Microsoft Azure DeploymentSettings 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 Deployment Settings. 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 4 operations across 2 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

4 operations 2 paths 27 schemas 1 DELETE2 GET1 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 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

DeploymentSettings 4
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/deploymentSettings
Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azurestackhci Clusters Clustername Deploymentsettings
microsoftAzureDeploymentsettingsListbyclusters 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/deploymentSettings/{deploymentSettingsName}
Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azurestackhci Clusters Clustername Deploymentsettings Deploymentsettingsname
microsoftAzureDeploymentsettingsGet 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/deploymentSettings/{deploymentSettingsName}
Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azurestackhci Clusters Clustername Deploymentsettings Deploymentsettingsname
microsoftAzureDeploymentsettingsCreateorupdate 5 params body → 200201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/deploymentSettings/{deploymentSettingsName}
Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azurestackhci Clusters Clustername Deploymentsettings Deploymentsettingsname
microsoftAzureDeploymentsettingsDelete 5 params → 202204default

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are DeploymentData (14 properties), DeploymentSecuritySettings (10 properties), Intents (9 properties), InfrastructureNetwork (5 properties). Each schema is shown below with its type and property counts.

Storage
object
The Storage config of AzureStackHCI Cluster.
1 property
OptionalServices
object
The OptionalServices of AzureStackHCI Cluster.
1 property
AdapterPropertyOverrides
object
The AdapterPropertyOverrides of a cluster.
3 properties
SdnIntegration
object
SDN Integration config to deploy AzureStackHCI Cluster.
1 property
NetworkController
object
network controller config for SDN Integration to deploy AzureStackHCI Cluster.
3 properties
DeploymentSetting
object
Edge device resource
1 property
SbeDeploymentInfo
object
Solution builder extension (SBE) package and manifest information for the solution builder extension staged for AzureStackHCI cluster deployment.
5 properties
SbePartnerInfo
object
The solution builder extension (SBE) partner deployment info for cluster.
3 properties
Observability
object
The Observability of AzureStackHCI Cluster.
3 properties
SbePartnerProperties
object
Solution builder extension (SBE) partner properties object.
2 properties
DeploymentConfiguration
object
Deployment Configuration
2 properties 1 required
ScaleUnits
object
Scale units will contains list of deployment data
2 properties 1 required
VirtualSwitchConfigurationOverrides
object
The VirtualSwitchConfigurationOverrides of a cluster.
2 properties
PhysicalNodes
object
The PhysicalNodes of a cluster.
2 properties
DeploymentSettingListResult
object
The response of a DeploymentSetting list operation.
2 properties 1 required
DeploymentCluster
object
AzureStackHCI Cluster deployment properties.
5 properties
QosPolicyOverrides
object
The QoSPolicyOverrides of a cluster.
3 properties
Intents
object
The Intents of a cluster.
9 properties
DeploymentData
object
The Deployment data of AzureStackHCI Cluster.
14 properties
DeploymentSettingsProperties
object
DeploymentSetting properties
5 properties 3 required
IpPools
object
The dnsServers of a device.
2 properties
InfrastructureNetwork
object
The InfrastructureNetwork of a AzureStackHCI Cluster.
5 properties
StorageNetworks
object
The StorageNetworks of a cluster.
4 properties
DeploymentSecuritySettings
object
The SecuritySettings of AzureStackHCI Cluster.
10 properties
HostNetwork
object
The HostNetwork of a cluster.
4 properties
SbeCredentials
object
secrets used for solution builder extension (SBE) partner extensibility.
3 properties
StorageAdapterIPInfo
object
The StorageAdapter physical nodes of a cluster.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-deploymentsettings-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 DeploymentSettings 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.