Microsoft.AzureStack (stable:2017-06-01)

2025/09/26 • 22 new, 22 deleted methods

Operations_List (new)
Description :  Returns the list of supported REST operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AzureStack/operations
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of operations ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation being performed on this particular object. ,
Required: False ,
}
string ,
display:
{
Description: Contains the localized display information for this particular operation or action. ,
Required: False ,
}
{
provider:
{
Description: The localized, friendly version of the resource provider name. ,
Required: False ,
}
string ,
resource:
{
Description: The localized, friendly version of the resource type related to this action or operation; the resource type should match the public documentation for the resource provider. ,
Required: False ,
}
string ,
operation:
{
Description: The localized, friendly name for the operation. Use the name as it will displayed to the user. ,
Required: False ,
}
string ,
description:
{
Description: The localized, friendly description for the operation. The description will be displayed to the user. It should be thorough and concise for used in both tooltips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
CloudManifestFile_List (new)
Description :  Returns a cloud specific manifest JSON file with latest version.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AzureStack/cloudManifestFiles
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Cloud specific manifest data. ,
Required: False ,
}
{
deploymentData:
{
Description: Cloud specific manifest data. ,
Required: False ,
}
{
externalDsmsCertificates:
{
Description: Dsms external certificates. ,
Required: False ,
}
string ,
customCloudVerificationKey:
{
Description: Signing verification public key. ,
Required: False ,
}
string ,
customEnvironmentEndpoints:
{
Description: Environment endpoints. ,
Required: False ,
}
{
customCloudArmEndpoint:
{
Description: ARM endpoint. ,
Required: False ,
}
string ,
externalDsmsEndpoint:
{
Description: Dsms endpoint. ,
Required: False ,
}
string ,
}
,
}
,
signature:
{
Description: Signature of the cloud specific manifest data. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
CloudManifestFile_Get (new)
Description :  Returns a cloud specific manifest JSON file.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AzureStack/cloudManifestFiles/{verificationVersion}
{
verificationVersion:
{
Description: Signing verification key version. ,
Required: True ,
}
string ,
versionCreationDate:
{
Description: Signing verification key version creation date. ,
Required: False ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Cloud specific manifest data. ,
Required: False ,
}
{
deploymentData:
{
Description: Cloud specific manifest data. ,
Required: False ,
}
{
externalDsmsCertificates:
{
Description: Dsms external certificates. ,
Required: False ,
}
string ,
customCloudVerificationKey:
{
Description: Signing verification public key. ,
Required: False ,
}
string ,
customEnvironmentEndpoints:
{
Description: Environment endpoints. ,
Required: False ,
}
{
customCloudArmEndpoint:
{
Description: ARM endpoint. ,
Required: False ,
}
string ,
externalDsmsEndpoint:
{
Description: Dsms endpoint. ,
Required: False ,
}
string ,
}
,
}
,
signature:
{
Description: Signature of the cloud specific manifest data. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
CustomerSubscriptions_List (new)
Description :  Returns a list of products.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/customerSubscriptions
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URI to the next page. ,
Required: False ,
}
string ,
value:
{
Description: List of customer subscriptions. ,
Required: False ,
}
[
{
properties:
{
Description: Customer subscription properties. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant Id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
CustomerSubscriptions_Get (new)
Description :  Returns the specified product.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/customerSubscriptions/{customerSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
customerSubscriptionName:
{
Description: Name of the product. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Customer subscription properties. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
CustomerSubscriptions_Delete (new)
Description :  Deletes a customer subscription under a registration.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/customerSubscriptions/{customerSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
customerSubscriptionName:
{
Description: Name of the product. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
CustomerSubscriptions_Create (new)
Description :  Creates a new customer subscription under a registration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/customerSubscriptions/{customerSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
customerSubscriptionName:
{
Description: Name of the product. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
customerCreationParameters:
{
Description: Parameters use to create a customer subscription. ,
Required: True ,
}
{
properties:
{
Description: Customer subscription properties. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant Id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Customer subscription properties. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Products_List (new)
Description :  Returns a list of products.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URI to the next page. ,
Required: False ,
}
string ,
value:
{
Description: List of products. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the product resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
description:
{
Description: The description of the product. ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The user-friendly name of the product publisher. ,
Required: False ,
}
string ,
publisherIdentifier:
{
Description: Publisher identifier. ,
Required: False ,
}
string ,
offer:
{
Description: The offer representing the product. ,
Required: False ,
}
string ,
offerVersion:
{
Description: The version of the product offer. ,
Required: False ,
}
string ,
sku:
{
Description: The product SKU. ,
Required: False ,
}
string ,
billingPartNumber:
{
Description: The part number used for billing purposes. ,
Required: False ,
}
string ,
vmExtensionType:
{
Description: The type of the Virtual Machine Extension. ,
Required: False ,
}
string ,
galleryItemIdentity:
{
Description: The identifier of the gallery item corresponding to the product. ,
Required: False ,
}
string ,
iconUris:
{
Description: Additional links available for this product. ,
Required: False ,
}
{
large:
{
Description: URI to large icon. ,
Required: False ,
}
string ,
wide:
{
Description: URI to wide icon. ,
Required: False ,
}
string ,
medium:
{
Description: URI to medium icon. ,
Required: False ,
}
string ,
small:
{
Description: URI to small icon. ,
Required: False ,
}
string ,
hero:
{
Description: URI to hero icon. ,
Required: False ,
}
string ,
}
,
links:
{
Description: Additional links available for this product. ,
Required: False ,
}
[
{
displayName:
{
Description: The description of the link. ,
Required: False ,
}
string ,
uri:
{
Description: The URI corresponding to the link. ,
Required: False ,
}
string ,
}
,
]
,
legalTerms:
{
Description: The legal terms. ,
Required: False ,
}
string ,
privacyPolicy:
{
Description: The privacy policy. ,
Required: False ,
}
string ,
payloadLength:
{
Description: The length of product content. ,
Format: int64 ,
Required: False ,
}
integer ,
productKind:
{
Description: The kind of the product (virtualMachine or virtualMachineExtension) ,
Required: False ,
}
string ,
productProperties:
{
Description: Additional properties for the product. ,
Required: False ,
}
{
version:
{
Description: The version. ,
Required: False ,
}
string ,
}
,
compatibility:
{
Description: Product compatibility with current device. ,
Required: False ,
}
{
isCompatible:
{
Description: Tells if product is compatible with current device ,
Required: False ,
}
boolean ,
message:
{
Description: Short error message if any compatibility issues are found ,
Required: False ,
}
string ,
description:
{
Description: Full error message if any compatibility issues are found ,
Required: False ,
}
string ,
issues:
{
Description: List of all issues found ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Products_Get (new)
Description :  Returns the specified product.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
productName:
{
Description: Name of the product. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the product resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
description:
{
Description: The description of the product. ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The user-friendly name of the product publisher. ,
Required: False ,
}
string ,
publisherIdentifier:
{
Description: Publisher identifier. ,
Required: False ,
}
string ,
offer:
{
Description: The offer representing the product. ,
Required: False ,
}
string ,
offerVersion:
{
Description: The version of the product offer. ,
Required: False ,
}
string ,
sku:
{
Description: The product SKU. ,
Required: False ,
}
string ,
billingPartNumber:
{
Description: The part number used for billing purposes. ,
Required: False ,
}
string ,
vmExtensionType:
{
Description: The type of the Virtual Machine Extension. ,
Required: False ,
}
string ,
galleryItemIdentity:
{
Description: The identifier of the gallery item corresponding to the product. ,
Required: False ,
}
string ,
iconUris:
{
Description: Additional links available for this product. ,
Required: False ,
}
{
large:
{
Description: URI to large icon. ,
Required: False ,
}
string ,
wide:
{
Description: URI to wide icon. ,
Required: False ,
}
string ,
medium:
{
Description: URI to medium icon. ,
Required: False ,
}
string ,
small:
{
Description: URI to small icon. ,
Required: False ,
}
string ,
hero:
{
Description: URI to hero icon. ,
Required: False ,
}
string ,
}
,
links:
{
Description: Additional links available for this product. ,
Required: False ,
}
[
{
displayName:
{
Description: The description of the link. ,
Required: False ,
}
string ,
uri:
{
Description: The URI corresponding to the link. ,
Required: False ,
}
string ,
}
,
]
,
legalTerms:
{
Description: The legal terms. ,
Required: False ,
}
string ,
privacyPolicy:
{
Description: The privacy policy. ,
Required: False ,
}
string ,
payloadLength:
{
Description: The length of product content. ,
Format: int64 ,
Required: False ,
}
integer ,
productKind:
{
Description: The kind of the product (virtualMachine or virtualMachineExtension) ,
Required: False ,
}
string ,
productProperties:
{
Description: Additional properties for the product. ,
Required: False ,
}
{
version:
{
Description: The version. ,
Required: False ,
}
string ,
}
,
compatibility:
{
Description: Product compatibility with current device. ,
Required: False ,
}
{
isCompatible:
{
Description: Tells if product is compatible with current device ,
Required: False ,
}
boolean ,
message:
{
Description: Short error message if any compatibility issues are found ,
Required: False ,
}
string ,
description:
{
Description: Full error message if any compatibility issues are found ,
Required: False ,
}
string ,
issues:
{
Description: List of all issues found ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Products_ListDetails (new)
Description :  Returns the extended properties of a product.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/listDetails
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
productName:
{
Description: Name of the product. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
galleryPackageBlobSasUri:
{
Description: The URI to the .azpkg file that provides information required for showing product in the gallery. ,
Required: False ,
}
string ,
productKind:
{
Description: Specifies the kind of the product (virtualMachine or virtualMachineExtension). ,
Required: False ,
}
string ,
properties:
{
Description: Specifies additional properties describing the product. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Products_ListProducts (new)
Description :  Returns a list of products.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/listProducts
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
productName:
{
Description: Name of the product. ,
Required: True ,
}
string ,
deviceConfiguration:
{
Description: Device configuration. ,
Required: False ,
}
{
deviceVersion:
{
Description: Version of the device. ,
Required: False ,
}
string ,
identitySystem:
{
Description: Identity system of the device. ,
Enum:
{
AzureAD: No description available. ,
ADFS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URI to the next page. ,
Required: False ,
}
string ,
value:
{
Description: List of products. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the product resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
description:
{
Description: The description of the product. ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The user-friendly name of the product publisher. ,
Required: False ,
}
string ,
publisherIdentifier:
{
Description: Publisher identifier. ,
Required: False ,
}
string ,
offer:
{
Description: The offer representing the product. ,
Required: False ,
}
string ,
offerVersion:
{
Description: The version of the product offer. ,
Required: False ,
}
string ,
sku:
{
Description: The product SKU. ,
Required: False ,
}
string ,
billingPartNumber:
{
Description: The part number used for billing purposes. ,
Required: False ,
}
string ,
vmExtensionType:
{
Description: The type of the Virtual Machine Extension. ,
Required: False ,
}
string ,
galleryItemIdentity:
{
Description: The identifier of the gallery item corresponding to the product. ,
Required: False ,
}
string ,
iconUris:
{
Description: Additional links available for this product. ,
Required: False ,
}
{
large:
{
Description: URI to large icon. ,
Required: False ,
}
string ,
wide:
{
Description: URI to wide icon. ,
Required: False ,
}
string ,
medium:
{
Description: URI to medium icon. ,
Required: False ,
}
string ,
small:
{
Description: URI to small icon. ,
Required: False ,
}
string ,
hero:
{
Description: URI to hero icon. ,
Required: False ,
}
string ,
}
,
links:
{
Description: Additional links available for this product. ,
Required: False ,
}
[
{
displayName:
{
Description: The description of the link. ,
Required: False ,
}
string ,
uri:
{
Description: The URI corresponding to the link. ,
Required: False ,
}
string ,
}
,
]
,
legalTerms:
{
Description: The legal terms. ,
Required: False ,
}
string ,
privacyPolicy:
{
Description: The privacy policy. ,
Required: False ,
}
string ,
payloadLength:
{
Description: The length of product content. ,
Format: int64 ,
Required: False ,
}
integer ,
productKind:
{
Description: The kind of the product (virtualMachine or virtualMachineExtension) ,
Required: False ,
}
string ,
productProperties:
{
Description: Additional properties for the product. ,
Required: False ,
}
{
version:
{
Description: The version. ,
Required: False ,
}
string ,
}
,
compatibility:
{
Description: Product compatibility with current device. ,
Required: False ,
}
{
isCompatible:
{
Description: Tells if product is compatible with current device ,
Required: False ,
}
boolean ,
message:
{
Description: Short error message if any compatibility issues are found ,
Required: False ,
}
string ,
description:
{
Description: Full error message if any compatibility issues are found ,
Required: False ,
}
string ,
issues:
{
Description: List of all issues found ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Products_GetProducts (new)
Description :  Returns a list of products.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/getProducts
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
productName:
{
Description: Name of the product. ,
Required: True ,
}
string ,
deviceConfiguration:
{
Description: Device configuration. ,
Required: False ,
}
{
deviceVersion:
{
Description: Version of the device. ,
Required: False ,
}
string ,
identitySystem:
{
Description: Identity system of the device. ,
Enum:
{
AzureAD: No description available. ,
ADFS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URI to the next page. ,
Required: False ,
}
string ,
value:
{
Description: List of products. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the product resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
description:
{
Description: The description of the product. ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The user-friendly name of the product publisher. ,
Required: False ,
}
string ,
publisherIdentifier:
{
Description: Publisher identifier. ,
Required: False ,
}
string ,
offer:
{
Description: The offer representing the product. ,
Required: False ,
}
string ,
offerVersion:
{
Description: The version of the product offer. ,
Required: False ,
}
string ,
sku:
{
Description: The product SKU. ,
Required: False ,
}
string ,
billingPartNumber:
{
Description: The part number used for billing purposes. ,
Required: False ,
}
string ,
vmExtensionType:
{
Description: The type of the Virtual Machine Extension. ,
Required: False ,
}
string ,
galleryItemIdentity:
{
Description: The identifier of the gallery item corresponding to the product. ,
Required: False ,
}
string ,
iconUris:
{
Description: Additional links available for this product. ,
Required: False ,
}
{
large:
{
Description: URI to large icon. ,
Required: False ,
}
string ,
wide:
{
Description: URI to wide icon. ,
Required: False ,
}
string ,
medium:
{
Description: URI to medium icon. ,
Required: False ,
}
string ,
small:
{
Description: URI to small icon. ,
Required: False ,
}
string ,
hero:
{
Description: URI to hero icon. ,
Required: False ,
}
string ,
}
,
links:
{
Description: Additional links available for this product. ,
Required: False ,
}
[
{
displayName:
{
Description: The description of the link. ,
Required: False ,
}
string ,
uri:
{
Description: The URI corresponding to the link. ,
Required: False ,
}
string ,
}
,
]
,
legalTerms:
{
Description: The legal terms. ,
Required: False ,
}
string ,
privacyPolicy:
{
Description: The privacy policy. ,
Required: False ,
}
string ,
payloadLength:
{
Description: The length of product content. ,
Format: int64 ,
Required: False ,
}
integer ,
productKind:
{
Description: The kind of the product (virtualMachine or virtualMachineExtension) ,
Required: False ,
}
string ,
productProperties:
{
Description: Additional properties for the product. ,
Required: False ,
}
{
version:
{
Description: The version. ,
Required: False ,
}
string ,
}
,
compatibility:
{
Description: Product compatibility with current device. ,
Required: False ,
}
{
isCompatible:
{
Description: Tells if product is compatible with current device ,
Required: False ,
}
boolean ,
message:
{
Description: Short error message if any compatibility issues are found ,
Required: False ,
}
string ,
description:
{
Description: Full error message if any compatibility issues are found ,
Required: False ,
}
string ,
issues:
{
Description: List of all issues found ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Products_GetProduct (new)
Description :  Returns the specified product.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/getProduct
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
productName:
{
Description: Name of the product. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
deviceConfiguration:
{
Description: Device configuration. ,
Required: False ,
}
{
deviceVersion:
{
Description: Version of the device. ,
Required: False ,
}
string ,
identitySystem:
{
Description: Identity system of the device. ,
Enum:
{
AzureAD: No description available. ,
ADFS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the product resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
description:
{
Description: The description of the product. ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The user-friendly name of the product publisher. ,
Required: False ,
}
string ,
publisherIdentifier:
{
Description: Publisher identifier. ,
Required: False ,
}
string ,
offer:
{
Description: The offer representing the product. ,
Required: False ,
}
string ,
offerVersion:
{
Description: The version of the product offer. ,
Required: False ,
}
string ,
sku:
{
Description: The product SKU. ,
Required: False ,
}
string ,
billingPartNumber:
{
Description: The part number used for billing purposes. ,
Required: False ,
}
string ,
vmExtensionType:
{
Description: The type of the Virtual Machine Extension. ,
Required: False ,
}
string ,
galleryItemIdentity:
{
Description: The identifier of the gallery item corresponding to the product. ,
Required: False ,
}
string ,
iconUris:
{
Description: Additional links available for this product. ,
Required: False ,
}
{
large:
{
Description: URI to large icon. ,
Required: False ,
}
string ,
wide:
{
Description: URI to wide icon. ,
Required: False ,
}
string ,
medium:
{
Description: URI to medium icon. ,
Required: False ,
}
string ,
small:
{
Description: URI to small icon. ,
Required: False ,
}
string ,
hero:
{
Description: URI to hero icon. ,
Required: False ,
}
string ,
}
,
links:
{
Description: Additional links available for this product. ,
Required: False ,
}
[
{
displayName:
{
Description: The description of the link. ,
Required: False ,
}
string ,
uri:
{
Description: The URI corresponding to the link. ,
Required: False ,
}
string ,
}
,
]
,
legalTerms:
{
Description: The legal terms. ,
Required: False ,
}
string ,
privacyPolicy:
{
Description: The privacy policy. ,
Required: False ,
}
string ,
payloadLength:
{
Description: The length of product content. ,
Format: int64 ,
Required: False ,
}
integer ,
productKind:
{
Description: The kind of the product (virtualMachine or virtualMachineExtension) ,
Required: False ,
}
string ,
productProperties:
{
Description: Additional properties for the product. ,
Required: False ,
}
{
version:
{
Description: The version. ,
Required: False ,
}
string ,
}
,
compatibility:
{
Description: Product compatibility with current device. ,
Required: False ,
}
{
isCompatible:
{
Description: Tells if product is compatible with current device ,
Required: False ,
}
boolean ,
message:
{
Description: Short error message if any compatibility issues are found ,
Required: False ,
}
string ,
description:
{
Description: Full error message if any compatibility issues are found ,
Required: False ,
}
string ,
issues:
{
Description: List of all issues found ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Products_UploadLog (new)
Description :  Returns the specified product.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/uploadProductLog
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
productName:
{
Description: Name of the product. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
marketplaceProductLogUpdate:
{
Description: Update details for product log. ,
Required: False ,
}
{
operation:
{
Description: Operation to log. ,
Required: False ,
}
string ,
status:
{
Description: Operation status to log. ,
Required: False ,
}
string ,
error:
{
Description: Error related to the operation. ,
Required: False ,
}
string ,
details:
{
Description: Error details related to operation. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Log ID. ,
Required: False ,
}
string ,
productId:
{
Description: Logged product ID. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Logged subscription ID. ,
Required: False ,
}
string ,
registrationName:
{
Description: Logged registration name. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Logged resource group name. ,
Required: False ,
}
string ,
operation:
{
Description: Logged operation. ,
Required: False ,
}
string ,
startDate:
{
Description: Operation start datetime. ,
Required: False ,
}
string ,
endDate:
{
Description: Operation end datetime. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: False ,
}
string ,
error:
{
Description: Operation error data. ,
Required: False ,
}
string ,
details:
{
Description: Operation error details. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Registrations_List (new)
Description :  Returns a list of all registrations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URI to the next page. ,
Required: False ,
}
string ,
value:
{
Description: List of Registrations ,
Required: False ,
}
[
{
properties:
{
Description: Registration resource. ,
Required: False ,
}
{
objectId:
{
Description: The object identifier associated with the Azure Stack connecting to Azure. ,
Required: False ,
}
string ,
cloudId:
{
Description: The identifier of the registered Azure Stack. ,
Required: False ,
}
string ,
billingModel:
{
Description: Specifies the billing mode for the Azure Stack registration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Registrations_ListBySubscription (new)
Description :  Returns a list of all registrations under current subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureStack/registrations
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URI to the next page. ,
Required: False ,
}
string ,
value:
{
Description: List of Registrations ,
Required: False ,
}
[
{
properties:
{
Description: Registration resource. ,
Required: False ,
}
{
objectId:
{
Description: The object identifier associated with the Azure Stack connecting to Azure. ,
Required: False ,
}
string ,
cloudId:
{
Description: The identifier of the registered Azure Stack. ,
Required: False ,
}
string ,
billingModel:
{
Description: Specifies the billing mode for the Azure Stack registration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Registrations_Get (new)
Description :  Returns the properties of an Azure Stack registration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Registration resource. ,
Required: False ,
}
{
objectId:
{
Description: The object identifier associated with the Azure Stack connecting to Azure. ,
Required: False ,
}
string ,
cloudId:
{
Description: The identifier of the registered Azure Stack. ,
Required: False ,
}
string ,
billingModel:
{
Description: Specifies the billing mode for the Azure Stack registration. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Registrations_Delete (new)
Description :  Delete the requested Azure Stack registration.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Registrations_CreateOrUpdate (new)
Description :  Create or update an Azure Stack registration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
token:
{
Description: Registration token ,
Required: True ,
}
{
properties:
{
Description: Properties of the Azure Stack registration resource ,
Required: True ,
}
{
registrationToken:
{
Description: The token identifying registered Azure Stack ,
Required: True ,
}
string ,
}
,
location:
{
Description: Location of the resource. ,
Enum:
{
global: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Registration resource. ,
Required: False ,
}
{
objectId:
{
Description: The object identifier associated with the Azure Stack connecting to Azure. ,
Required: False ,
}
string ,
cloudId:
{
Description: The identifier of the registered Azure Stack. ,
Required: False ,
}
string ,
billingModel:
{
Description: Specifies the billing mode for the Azure Stack registration. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Registration resource. ,
Required: False ,
}
{
objectId:
{
Description: The object identifier associated with the Azure Stack connecting to Azure. ,
Required: False ,
}
string ,
cloudId:
{
Description: The identifier of the registered Azure Stack. ,
Required: False ,
}
string ,
billingModel:
{
Description: Specifies the billing mode for the Azure Stack registration. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Registrations_Update (new)
Description :  Patch an Azure Stack registration.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
token:
{
Description: Registration token ,
Required: True ,
}
{
properties:
{
Description: Properties of the Azure Stack registration resource ,
Required: True ,
}
{
registrationToken:
{
Description: The token identifying registered Azure Stack ,
Required: True ,
}
string ,
}
,
location:
{
Description: Location of the resource. ,
Enum:
{
global: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Registration resource. ,
Required: False ,
}
{
objectId:
{
Description: The object identifier associated with the Azure Stack connecting to Azure. ,
Required: False ,
}
string ,
cloudId:
{
Description: The identifier of the registered Azure Stack. ,
Required: False ,
}
string ,
billingModel:
{
Description: Specifies the billing mode for the Azure Stack registration. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Registrations_GetActivationKey (new)
Description :  Returns Azure Stack Activation Key.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/getactivationkey
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
activationKey:
{
Description: Azure Stack activation key. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Registrations_EnableRemoteManagement (new)
Description :  Enables remote management for device under the Azure Stack registration.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/enableRemoteManagement
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  Returns the list of supported REST operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AzureStack/operations
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of operations ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation being performed on this particular object. ,
Required: False ,
}
string ,
display:
{
Description: Contains the localized display information for this particular operation or action. ,
Required: False ,
}
{
provider:
{
Description: The localized, friendly version of the resource provider name. ,
Required: False ,
}
string ,
resource:
{
Description: The localized, friendly version of the resource type related to this action or operation; the resource type should match the public documentation for the resource provider. ,
Required: False ,
}
string ,
operation:
{
Description: The localized, friendly name for the operation. Use the name as it will displayed to the user. ,
Required: False ,
}
string ,
description:
{
Description: The localized, friendly description for the operation. The description will be displayed to the user. It should be thorough and concise for used in both tooltips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to the next page of operations. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
CloudManifestFile_List (removed)
Description :  Returns a cloud specific manifest JSON file with latest version.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AzureStack/cloudManifestFiles
{
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Cloud specific manifest data. ,
Required: False ,
}
{
deploymentData:
{
Description: Cloud specific manifest data. ,
Required: False ,
}
{
externalDsmsCertificates:
{
Description: Dsms external certificates. ,
Required: False ,
}
string ,
customCloudVerificationKey:
{
Description: Signing verification public key. ,
Required: False ,
}
string ,
customEnvironmentEndpoints:
{
Description: Environment endpoints. ,
Required: False ,
}
{
customCloudArmEndpoint:
{
Description: ARM endpoint. ,
Required: False ,
}
string ,
externalDsmsEndpoint:
{
Description: Dsms endpoint. ,
Required: False ,
}
string ,
}
,
}
,
signature:
{
Description: Signature of the cloud specific manifest data. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
CloudManifestFile_Get (removed)
Description :  Returns a cloud specific manifest JSON file.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AzureStack/cloudManifestFiles/{verificationVersion}
{
verificationVersion:
{
Description: Signing verification key version. ,
Required: True ,
}
string ,
versionCreationDate:
{
Description: Signing verification key version creation date. ,
Required: False ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Cloud specific manifest data. ,
Required: False ,
}
{
deploymentData:
{
Description: Cloud specific manifest data. ,
Required: False ,
}
{
externalDsmsCertificates:
{
Description: Dsms external certificates. ,
Required: False ,
}
string ,
customCloudVerificationKey:
{
Description: Signing verification public key. ,
Required: False ,
}
string ,
customEnvironmentEndpoints:
{
Description: Environment endpoints. ,
Required: False ,
}
{
customCloudArmEndpoint:
{
Description: ARM endpoint. ,
Required: False ,
}
string ,
externalDsmsEndpoint:
{
Description: Dsms endpoint. ,
Required: False ,
}
string ,
}
,
}
,
signature:
{
Description: Signature of the cloud specific manifest data. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
CustomerSubscriptions_List (removed)
Description :  Returns a list of products.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/customerSubscriptions
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URI to the next page. ,
Required: False ,
}
string ,
value:
{
Description: List of customer subscriptions. ,
Required: False ,
}
[
{
properties:
{
Description: Customer subscription properties. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant Id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
CustomerSubscriptions_Get (removed)
Description :  Returns the specified product.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/customerSubscriptions/{customerSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
customerSubscriptionName:
{
Description: Name of the product. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Customer subscription properties. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
CustomerSubscriptions_Delete (removed)
Description :  Deletes a customer subscription under a registration.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/customerSubscriptions/{customerSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
customerSubscriptionName:
{
Description: Name of the product. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
CustomerSubscriptions_Create (removed)
Description :  Creates a new customer subscription under a registration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/customerSubscriptions/{customerSubscriptionName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
customerSubscriptionName:
{
Description: Name of the product. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
customerCreationParameters:
{
Description: Parameters use to create a customer subscription. ,
Required: True ,
}
{
properties:
{
Description: Customer subscription properties. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant Id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Customer subscription properties. ,
Required: False ,
}
{
tenantId:
{
Description: Tenant Id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Products_List (removed)
Description :  Returns a list of products.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URI to the next page. ,
Required: False ,
}
string ,
value:
{
Description: List of products. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the product resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
description:
{
Description: The description of the product. ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The user-friendly name of the product publisher. ,
Required: False ,
}
string ,
publisherIdentifier:
{
Description: Publisher identifier. ,
Required: False ,
}
string ,
offer:
{
Description: The offer representing the product. ,
Required: False ,
}
string ,
offerVersion:
{
Description: The version of the product offer. ,
Required: False ,
}
string ,
sku:
{
Description: The product SKU. ,
Required: False ,
}
string ,
billingPartNumber:
{
Description: The part number used for billing purposes. ,
Required: False ,
}
string ,
vmExtensionType:
{
Description: The type of the Virtual Machine Extension. ,
Required: False ,
}
string ,
galleryItemIdentity:
{
Description: The identifier of the gallery item corresponding to the product. ,
Required: False ,
}
string ,
iconUris:
{
Description: Additional links available for this product. ,
Required: False ,
}
{
large:
{
Description: URI to large icon. ,
Required: False ,
}
string ,
wide:
{
Description: URI to wide icon. ,
Required: False ,
}
string ,
medium:
{
Description: URI to medium icon. ,
Required: False ,
}
string ,
small:
{
Description: URI to small icon. ,
Required: False ,
}
string ,
hero:
{
Description: URI to hero icon. ,
Required: False ,
}
string ,
}
,
links:
{
Description: Additional links available for this product. ,
Required: False ,
}
[
{
displayName:
{
Description: The description of the link. ,
Required: False ,
}
string ,
uri:
{
Description: The URI corresponding to the link. ,
Required: False ,
}
string ,
}
,
]
,
legalTerms:
{
Description: The legal terms. ,
Required: False ,
}
string ,
privacyPolicy:
{
Description: The privacy policy. ,
Required: False ,
}
string ,
payloadLength:
{
Description: The length of product content. ,
Format: int64 ,
Required: False ,
}
integer ,
productKind:
{
Description: The kind of the product (virtualMachine or virtualMachineExtension) ,
Required: False ,
}
string ,
productProperties:
{
Description: Additional properties for the product. ,
Required: False ,
}
{
version:
{
Description: The version. ,
Required: False ,
}
string ,
}
,
compatibility:
{
Description: Product compatibility with current device. ,
Required: False ,
}
{
isCompatible:
{
Description: Tells if product is compatible with current device ,
Required: False ,
}
boolean ,
message:
{
Description: Short error message if any compatibility issues are found ,
Required: False ,
}
string ,
description:
{
Description: Full error message if any compatibility issues are found ,
Required: False ,
}
string ,
issues:
{
Description: List of all issues found ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Products_Get (removed)
Description :  Returns the specified product.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
productName:
{
Description: Name of the product. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the product resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
description:
{
Description: The description of the product. ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The user-friendly name of the product publisher. ,
Required: False ,
}
string ,
publisherIdentifier:
{
Description: Publisher identifier. ,
Required: False ,
}
string ,
offer:
{
Description: The offer representing the product. ,
Required: False ,
}
string ,
offerVersion:
{
Description: The version of the product offer. ,
Required: False ,
}
string ,
sku:
{
Description: The product SKU. ,
Required: False ,
}
string ,
billingPartNumber:
{
Description: The part number used for billing purposes. ,
Required: False ,
}
string ,
vmExtensionType:
{
Description: The type of the Virtual Machine Extension. ,
Required: False ,
}
string ,
galleryItemIdentity:
{
Description: The identifier of the gallery item corresponding to the product. ,
Required: False ,
}
string ,
iconUris:
{
Description: Additional links available for this product. ,
Required: False ,
}
{
large:
{
Description: URI to large icon. ,
Required: False ,
}
string ,
wide:
{
Description: URI to wide icon. ,
Required: False ,
}
string ,
medium:
{
Description: URI to medium icon. ,
Required: False ,
}
string ,
small:
{
Description: URI to small icon. ,
Required: False ,
}
string ,
hero:
{
Description: URI to hero icon. ,
Required: False ,
}
string ,
}
,
links:
{
Description: Additional links available for this product. ,
Required: False ,
}
[
{
displayName:
{
Description: The description of the link. ,
Required: False ,
}
string ,
uri:
{
Description: The URI corresponding to the link. ,
Required: False ,
}
string ,
}
,
]
,
legalTerms:
{
Description: The legal terms. ,
Required: False ,
}
string ,
privacyPolicy:
{
Description: The privacy policy. ,
Required: False ,
}
string ,
payloadLength:
{
Description: The length of product content. ,
Format: int64 ,
Required: False ,
}
integer ,
productKind:
{
Description: The kind of the product (virtualMachine or virtualMachineExtension) ,
Required: False ,
}
string ,
productProperties:
{
Description: Additional properties for the product. ,
Required: False ,
}
{
version:
{
Description: The version. ,
Required: False ,
}
string ,
}
,
compatibility:
{
Description: Product compatibility with current device. ,
Required: False ,
}
{
isCompatible:
{
Description: Tells if product is compatible with current device ,
Required: False ,
}
boolean ,
message:
{
Description: Short error message if any compatibility issues are found ,
Required: False ,
}
string ,
description:
{
Description: Full error message if any compatibility issues are found ,
Required: False ,
}
string ,
issues:
{
Description: List of all issues found ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Products_ListDetails (removed)
Description :  Returns the extended properties of a product.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/listDetails
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
productName:
{
Description: Name of the product. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
galleryPackageBlobSasUri:
{
Description: The URI to the .azpkg file that provides information required for showing product in the gallery. ,
Required: False ,
}
string ,
productKind:
{
Description: Specifies the kind of the product (virtualMachine or virtualMachineExtension). ,
Required: False ,
}
string ,
properties:
{
Description: Specifies additional properties describing the product. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Products_ListProducts (removed)
Description :  Returns a list of products.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/listProducts
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
productName:
{
Description: Name of the product. ,
Required: True ,
}
string ,
deviceConfiguration:
{
Description: Device configuration. ,
Required: False ,
}
{
deviceVersion:
{
Description: Version of the device. ,
Required: False ,
}
string ,
identitySystem:
{
Description: Identity system of the device. ,
Enum:
{
AzureAD: No description available. ,
ADFS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URI to the next page. ,
Required: False ,
}
string ,
value:
{
Description: List of products. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the product resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
description:
{
Description: The description of the product. ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The user-friendly name of the product publisher. ,
Required: False ,
}
string ,
publisherIdentifier:
{
Description: Publisher identifier. ,
Required: False ,
}
string ,
offer:
{
Description: The offer representing the product. ,
Required: False ,
}
string ,
offerVersion:
{
Description: The version of the product offer. ,
Required: False ,
}
string ,
sku:
{
Description: The product SKU. ,
Required: False ,
}
string ,
billingPartNumber:
{
Description: The part number used for billing purposes. ,
Required: False ,
}
string ,
vmExtensionType:
{
Description: The type of the Virtual Machine Extension. ,
Required: False ,
}
string ,
galleryItemIdentity:
{
Description: The identifier of the gallery item corresponding to the product. ,
Required: False ,
}
string ,
iconUris:
{
Description: Additional links available for this product. ,
Required: False ,
}
{
large:
{
Description: URI to large icon. ,
Required: False ,
}
string ,
wide:
{
Description: URI to wide icon. ,
Required: False ,
}
string ,
medium:
{
Description: URI to medium icon. ,
Required: False ,
}
string ,
small:
{
Description: URI to small icon. ,
Required: False ,
}
string ,
hero:
{
Description: URI to hero icon. ,
Required: False ,
}
string ,
}
,
links:
{
Description: Additional links available for this product. ,
Required: False ,
}
[
{
displayName:
{
Description: The description of the link. ,
Required: False ,
}
string ,
uri:
{
Description: The URI corresponding to the link. ,
Required: False ,
}
string ,
}
,
]
,
legalTerms:
{
Description: The legal terms. ,
Required: False ,
}
string ,
privacyPolicy:
{
Description: The privacy policy. ,
Required: False ,
}
string ,
payloadLength:
{
Description: The length of product content. ,
Format: int64 ,
Required: False ,
}
integer ,
productKind:
{
Description: The kind of the product (virtualMachine or virtualMachineExtension) ,
Required: False ,
}
string ,
productProperties:
{
Description: Additional properties for the product. ,
Required: False ,
}
{
version:
{
Description: The version. ,
Required: False ,
}
string ,
}
,
compatibility:
{
Description: Product compatibility with current device. ,
Required: False ,
}
{
isCompatible:
{
Description: Tells if product is compatible with current device ,
Required: False ,
}
boolean ,
message:
{
Description: Short error message if any compatibility issues are found ,
Required: False ,
}
string ,
description:
{
Description: Full error message if any compatibility issues are found ,
Required: False ,
}
string ,
issues:
{
Description: List of all issues found ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Products_GetProducts (removed)
Description :  Returns a list of products.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/getProducts
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
productName:
{
Description: Name of the product. ,
Required: True ,
}
string ,
deviceConfiguration:
{
Description: Device configuration. ,
Required: False ,
}
{
deviceVersion:
{
Description: Version of the device. ,
Required: False ,
}
string ,
identitySystem:
{
Description: Identity system of the device. ,
Enum:
{
AzureAD: No description available. ,
ADFS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URI to the next page. ,
Required: False ,
}
string ,
value:
{
Description: List of products. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the product resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
description:
{
Description: The description of the product. ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The user-friendly name of the product publisher. ,
Required: False ,
}
string ,
publisherIdentifier:
{
Description: Publisher identifier. ,
Required: False ,
}
string ,
offer:
{
Description: The offer representing the product. ,
Required: False ,
}
string ,
offerVersion:
{
Description: The version of the product offer. ,
Required: False ,
}
string ,
sku:
{
Description: The product SKU. ,
Required: False ,
}
string ,
billingPartNumber:
{
Description: The part number used for billing purposes. ,
Required: False ,
}
string ,
vmExtensionType:
{
Description: The type of the Virtual Machine Extension. ,
Required: False ,
}
string ,
galleryItemIdentity:
{
Description: The identifier of the gallery item corresponding to the product. ,
Required: False ,
}
string ,
iconUris:
{
Description: Additional links available for this product. ,
Required: False ,
}
{
large:
{
Description: URI to large icon. ,
Required: False ,
}
string ,
wide:
{
Description: URI to wide icon. ,
Required: False ,
}
string ,
medium:
{
Description: URI to medium icon. ,
Required: False ,
}
string ,
small:
{
Description: URI to small icon. ,
Required: False ,
}
string ,
hero:
{
Description: URI to hero icon. ,
Required: False ,
}
string ,
}
,
links:
{
Description: Additional links available for this product. ,
Required: False ,
}
[
{
displayName:
{
Description: The description of the link. ,
Required: False ,
}
string ,
uri:
{
Description: The URI corresponding to the link. ,
Required: False ,
}
string ,
}
,
]
,
legalTerms:
{
Description: The legal terms. ,
Required: False ,
}
string ,
privacyPolicy:
{
Description: The privacy policy. ,
Required: False ,
}
string ,
payloadLength:
{
Description: The length of product content. ,
Format: int64 ,
Required: False ,
}
integer ,
productKind:
{
Description: The kind of the product (virtualMachine or virtualMachineExtension) ,
Required: False ,
}
string ,
productProperties:
{
Description: Additional properties for the product. ,
Required: False ,
}
{
version:
{
Description: The version. ,
Required: False ,
}
string ,
}
,
compatibility:
{
Description: Product compatibility with current device. ,
Required: False ,
}
{
isCompatible:
{
Description: Tells if product is compatible with current device ,
Required: False ,
}
boolean ,
message:
{
Description: Short error message if any compatibility issues are found ,
Required: False ,
}
string ,
description:
{
Description: Full error message if any compatibility issues are found ,
Required: False ,
}
string ,
issues:
{
Description: List of all issues found ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Products_GetProduct (removed)
Description :  Returns the specified product.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/getProduct
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
productName:
{
Description: Name of the product. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
deviceConfiguration:
{
Description: Device configuration. ,
Required: False ,
}
{
deviceVersion:
{
Description: Version of the device. ,
Required: False ,
}
string ,
identitySystem:
{
Description: Identity system of the device. ,
Enum:
{
AzureAD: No description available. ,
ADFS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the product resource. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
description:
{
Description: The description of the product. ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: The user-friendly name of the product publisher. ,
Required: False ,
}
string ,
publisherIdentifier:
{
Description: Publisher identifier. ,
Required: False ,
}
string ,
offer:
{
Description: The offer representing the product. ,
Required: False ,
}
string ,
offerVersion:
{
Description: The version of the product offer. ,
Required: False ,
}
string ,
sku:
{
Description: The product SKU. ,
Required: False ,
}
string ,
billingPartNumber:
{
Description: The part number used for billing purposes. ,
Required: False ,
}
string ,
vmExtensionType:
{
Description: The type of the Virtual Machine Extension. ,
Required: False ,
}
string ,
galleryItemIdentity:
{
Description: The identifier of the gallery item corresponding to the product. ,
Required: False ,
}
string ,
iconUris:
{
Description: Additional links available for this product. ,
Required: False ,
}
{
large:
{
Description: URI to large icon. ,
Required: False ,
}
string ,
wide:
{
Description: URI to wide icon. ,
Required: False ,
}
string ,
medium:
{
Description: URI to medium icon. ,
Required: False ,
}
string ,
small:
{
Description: URI to small icon. ,
Required: False ,
}
string ,
hero:
{
Description: URI to hero icon. ,
Required: False ,
}
string ,
}
,
links:
{
Description: Additional links available for this product. ,
Required: False ,
}
[
{
displayName:
{
Description: The description of the link. ,
Required: False ,
}
string ,
uri:
{
Description: The URI corresponding to the link. ,
Required: False ,
}
string ,
}
,
]
,
legalTerms:
{
Description: The legal terms. ,
Required: False ,
}
string ,
privacyPolicy:
{
Description: The privacy policy. ,
Required: False ,
}
string ,
payloadLength:
{
Description: The length of product content. ,
Format: int64 ,
Required: False ,
}
integer ,
productKind:
{
Description: The kind of the product (virtualMachine or virtualMachineExtension) ,
Required: False ,
}
string ,
productProperties:
{
Description: Additional properties for the product. ,
Required: False ,
}
{
version:
{
Description: The version. ,
Required: False ,
}
string ,
}
,
compatibility:
{
Description: Product compatibility with current device. ,
Required: False ,
}
{
isCompatible:
{
Description: Tells if product is compatible with current device ,
Required: False ,
}
boolean ,
message:
{
Description: Short error message if any compatibility issues are found ,
Required: False ,
}
string ,
description:
{
Description: Full error message if any compatibility issues are found ,
Required: False ,
}
string ,
issues:
{
Description: List of all issues found ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Products_UploadLog (removed)
Description :  Returns the specified product.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/products/{productName}/uploadProductLog
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
productName:
{
Description: Name of the product. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
marketplaceProductLogUpdate:
{
Description: Update details for product log. ,
Required: False ,
}
{
operation:
{
Description: Operation to log. ,
Required: False ,
}
string ,
status:
{
Description: Operation status to log. ,
Required: False ,
}
string ,
error:
{
Description: Error related to the operation. ,
Required: False ,
}
string ,
details:
{
Description: Error details related to operation. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Log ID. ,
Required: False ,
}
string ,
productId:
{
Description: Logged product ID. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Logged subscription ID. ,
Required: False ,
}
string ,
registrationName:
{
Description: Logged registration name. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Logged resource group name. ,
Required: False ,
}
string ,
operation:
{
Description: Logged operation. ,
Required: False ,
}
string ,
startDate:
{
Description: Operation start datetime. ,
Required: False ,
}
string ,
endDate:
{
Description: Operation end datetime. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: False ,
}
string ,
error:
{
Description: Operation error data. ,
Required: False ,
}
string ,
details:
{
Description: Operation error details. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Registrations_List (removed)
Description :  Returns a list of all registrations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URI to the next page. ,
Required: False ,
}
string ,
value:
{
Description: List of Registrations ,
Required: False ,
}
[
{
properties:
{
Description: Registration resource. ,
Required: False ,
}
{
objectId:
{
Description: The object identifier associated with the Azure Stack connecting to Azure. ,
Required: False ,
}
string ,
cloudId:
{
Description: The identifier of the registered Azure Stack. ,
Required: False ,
}
string ,
billingModel:
{
Description: Specifies the billing mode for the Azure Stack registration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Registrations_ListBySubscription (removed)
Description :  Returns a list of all registrations under current subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureStack/registrations
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URI to the next page. ,
Required: False ,
}
string ,
value:
{
Description: List of Registrations ,
Required: False ,
}
[
{
properties:
{
Description: Registration resource. ,
Required: False ,
}
{
objectId:
{
Description: The object identifier associated with the Azure Stack connecting to Azure. ,
Required: False ,
}
string ,
cloudId:
{
Description: The identifier of the registered Azure Stack. ,
Required: False ,
}
string ,
billingModel:
{
Description: Specifies the billing mode for the Azure Stack registration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Registrations_Get (removed)
Description :  Returns the properties of an Azure Stack registration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Registration resource. ,
Required: False ,
}
{
objectId:
{
Description: The object identifier associated with the Azure Stack connecting to Azure. ,
Required: False ,
}
string ,
cloudId:
{
Description: The identifier of the registered Azure Stack. ,
Required: False ,
}
string ,
billingModel:
{
Description: Specifies the billing mode for the Azure Stack registration. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Registrations_Delete (removed)
Description :  Delete the requested Azure Stack registration.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Registrations_CreateOrUpdate (removed)
Description :  Create or update an Azure Stack registration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
token:
{
Description: Registration token ,
Required: True ,
}
{
properties:
{
Description: Properties of the Azure Stack registration resource ,
Required: True ,
}
{
registrationToken:
{
Description: The token identifying registered Azure Stack ,
Required: True ,
}
string ,
}
,
location:
{
Description: Location of the resource. ,
Enum:
{
global: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Registration resource. ,
Required: False ,
}
{
objectId:
{
Description: The object identifier associated with the Azure Stack connecting to Azure. ,
Required: False ,
}
string ,
cloudId:
{
Description: The identifier of the registered Azure Stack. ,
Required: False ,
}
string ,
billingModel:
{
Description: Specifies the billing mode for the Azure Stack registration. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Registration resource. ,
Required: False ,
}
{
objectId:
{
Description: The object identifier associated with the Azure Stack connecting to Azure. ,
Required: False ,
}
string ,
cloudId:
{
Description: The identifier of the registered Azure Stack. ,
Required: False ,
}
string ,
billingModel:
{
Description: Specifies the billing mode for the Azure Stack registration. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Registrations_Update (removed)
Description :  Patch an Azure Stack registration.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
token:
{
Description: Registration token ,
Required: True ,
}
{
properties:
{
Description: Properties of the Azure Stack registration resource ,
Required: True ,
}
{
registrationToken:
{
Description: The token identifying registered Azure Stack ,
Required: True ,
}
string ,
}
,
location:
{
Description: Location of the resource. ,
Enum:
{
global: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Registration resource. ,
Required: False ,
}
{
objectId:
{
Description: The object identifier associated with the Azure Stack connecting to Azure. ,
Required: False ,
}
string ,
cloudId:
{
Description: The identifier of the registered Azure Stack. ,
Required: False ,
}
string ,
billingModel:
{
Description: Specifies the billing mode for the Azure Stack registration. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Registrations_GetActivationKey (removed)
Description :  Returns Azure Stack Activation Key.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/getactivationkey
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
activationKey:
{
Description: Azure Stack activation key. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Registrations_EnableRemoteManagement (removed)
Description :  Enables remote management for device under the Azure Stack registration.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AzureStack/registrations/{registrationName}/enableRemoteManagement
{
subscriptionId:
{
Description: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
registrationName:
{
Description: Name of the Azure Stack registration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}