Azure Stack Hub Reference

Comprehensive reference documentation for Azure Stack Hub, enabling you to build and run hybrid cloud solutions with Azure services.

Getting Started

Overview of Azure Stack Hub

Understand the core concepts, architecture, and capabilities of Azure Stack Hub for consistent hybrid cloud deployments.

Deploy Azure Stack Hub

Step-by-step guides for planning, preparing, and deploying your Azure Stack Hub integrated system.

Operate Azure Stack Hub

Learn how to manage, monitor, and maintain your Azure Stack Hub environment effectively.

Azure Stack Hub Architecture

Dive deep into the components and how they work together to deliver Azure services on-premises.

Integrated Systems

Explore hardware solutions from Microsoft partners that are validated for Azure Stack Hub.

Capacity Planning

Guidance on estimating and managing the resources required for your Azure Stack Hub deployment.

Azure Stack Hub Marketplace

Discover and deploy virtual machine images, services, and solutions from the Azure Stack Hub Marketplace.

API Reference

Access detailed information about the Azure Stack Hub APIs, including REST APIs, SDKs, and PowerShell modules.

Azure Stack Hub REST API

Interact with Azure Stack Hub programmatically using the RESTful interface.

The Azure Stack Hub REST API provides a programmatic interface to manage resources and services within your Azure Stack Hub cloud.

Authentication: Details on how to authenticate requests.
Resource Provider Operations: Operations for compute, storage, networking, and more.
Service Endpoints: Common endpoints for interacting with services.

Example API Call:

GET https://{cloud}.azurestack.corp.microsoft.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines?api-version=2020-09-01

View full REST API documentation

Azure Stack Hub PowerShell Module

Manage your Azure Stack Hub resources using familiar PowerShell cmdlets.

The Azure Stack Hub PowerShell module extends the Azure PowerShell capabilities to manage your hybrid cloud environment.

Installation: How to install the necessary PowerShell modules.
Common Cmdlets: Examples for creating VMs, managing storage accounts, and configuring networks.
Connect-AzsAccount: Cmdlet for connecting to your Azure Stack Hub endpoint.

Example PowerShell Script:

Connect-AzsAccount -EnvironmentName AzureStackHub
Get-AzVM -ResourceGroupName MyResourceGroup

View PowerShell module reference

Azure Stack Hub SDKs

Integrate Azure Stack Hub management into your applications using various language SDKs.

Leverage Azure Stack Hub SDKs for languages like .NET, Python, Java, and Go to automate and manage your hybrid cloud resources.

Supported Languages: List of available SDKs.
Quickstarts: Code samples for common management tasks.
Authentication with SDKs: How to handle authentication in your code.

Example SDK Snippet (Python):

from azure.mgmt.compute import ComputeManagementClient
from azure.identity import DefaultAzureCredential

credential = DefaultAzureCredential()
subscription_id = 'YOUR_SUBSCRIPTION_ID'
client = ComputeManagementClient(credential, subscription_id, base_url='https://management.azurestack.corp.microsoft.com')
# List virtual machines
vms = client.virtual_machines.list_all()

Explore Azure Stack Hub SDKs