Microsoft.HybridCompute (preview:2019-08-02)

2025/10/23 • 13 new, 13 deleted methods

Machines_CreateOrUpdate (new)
Description :  The operation to create or update a hybrid machine resource identity in Azure.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create hybrid machine operation. ,
Required: True ,
}
{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
physicalLocation:
{
Description: Resource's Physical Location ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
physicalLocation:
{
Description: Resource's Physical Location ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Machines_Update (new)
Description :  The operation to update a hybrid machine.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update hybrid machine operation. ,
Required: True ,
}
{
identity:
{
Description: Hybrid Compute Machine Managed Identity ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Required: False ,
}
string ,
principalId:
{
Description: The identity's principal id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The identity's tenant id. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
physicalLocation:
{
Description: Resource's Physical Location ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
physicalLocation:
{
Description: Resource's Physical Location ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Machines_Delete (new)
Description :  The operation to remove a hybrid machine identity in Azure.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Machines_Get (new)
Description :  Retrieves information about the model view or the instance view of a hybrid machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
physicalLocation:
{
Description: Resource's Physical Location ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Machines_Reconnect (new)
Description :  The operation to reconnect a hybrid machine resource to its identity in Azure.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/reconnect
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Reconnect hybrid machine operation. ,
Required: True ,
}
{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
physicalLocation:
{
Description: Resource's Physical Location ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Machines_ListByResourceGroup (new)
Description :  Lists all the hybrid machines in the specified resource group. Use the nextLink property in the response to get the next page of hybrid machines.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of hybrid machines. ,
Required: True ,
}
[
{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
physicalLocation:
{
Description: Resource's Physical Location ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of hybrid machines. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Machines_ListBySubscription (new)
Description :  Lists all the hybrid machines in the specified subscription. Use the nextLink property in the response to get the next page of hybrid machines.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of hybrid machines. ,
Required: True ,
}
[
{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
physicalLocation:
{
Description: Resource's Physical Location ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of hybrid machines. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MachineExtensions_CreateOrUpdate (new)
Description :  The operation to create or update the extension.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine where the extension should be created or updated. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
extensionParameters:
{
Description: Parameters supplied to the Create Machine Extension operation. ,
Required: True ,
}
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}
MachineExtensions_Update (new)
Description :  The operation to create or update the extension.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine where the extension should be created or updated. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
extensionParameters:
{
Description: Parameters supplied to the Create Machine Extension operation. ,
Required: True ,
}
{
properties:
{
Description: Describes Machine Extension Update Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}
MachineExtensions_Delete (new)
Description :  The operation to delete the extension.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine where the extension should be deleted. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
MachineExtensions_Get (new)
Description :  The operation to get the extension.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine containing the extension. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
MachineExtensions_List (new)
Description :  The operation to get all extensions of a non-Azure machine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine containing the extension. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of extensions ,
Required: False ,
}
[
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of machine extensions. Call ListNext() with this to fetch the next page of extensions. ,
Required: False ,
}
string ,
}
Operations_List (new)
Description :  Gets a list of hybrid compute operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of compute operations ,
Required: False ,
}
[
{
origin:
{
Description: The origin of the compute operation. ,
Required: False ,
}
string ,
name:
{
Description: The name of the compute operation. ,
Required: False ,
}
string ,
display:
{
Description: Display properties ,
Required: False ,
}
{
operation:
{
Description: The display name of the compute operation. ,
Required: False ,
}
string ,
resource:
{
Description: The display name of the resource the operation applies to. ,
Required: False ,
}
string ,
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
provider:
{
Description: The resource provider for the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Machines_CreateOrUpdate (removed)
Description :  The operation to create or update a hybrid machine resource identity in Azure.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create hybrid machine operation. ,
Required: True ,
}
{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
physicalLocation:
{
Description: Resource's Physical Location ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
physicalLocation:
{
Description: Resource's Physical Location ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Machines_Update (removed)
Description :  The operation to update a hybrid machine.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update hybrid machine operation. ,
Required: True ,
}
{
identity:
{
Description: Hybrid Compute Machine Managed Identity ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Required: False ,
}
string ,
principalId:
{
Description: The identity's principal id. ,
Required: False ,
}
string ,
tenantId:
{
Description: The identity's tenant id. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
physicalLocation:
{
Description: Resource's Physical Location ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
physicalLocation:
{
Description: Resource's Physical Location ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Machines_Delete (removed)
Description :  The operation to remove a hybrid machine identity in Azure.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Machines_Get (removed)
Description :  Retrieves information about the model view or the instance view of a hybrid machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
physicalLocation:
{
Description: Resource's Physical Location ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Machines_Reconnect (removed)
Description :  The operation to reconnect a hybrid machine resource to its identity in Azure.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/reconnect
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Reconnect hybrid machine operation. ,
Required: True ,
}
{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
physicalLocation:
{
Description: Resource's Physical Location ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Machines_ListByResourceGroup (removed)
Description :  Lists all the hybrid machines in the specified resource group. Use the nextLink property in the response to get the next page of hybrid machines.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of hybrid machines. ,
Required: True ,
}
[
{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
physicalLocation:
{
Description: Resource's Physical Location ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of hybrid machines. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Machines_ListBySubscription (removed)
Description :  Lists all the hybrid machines in the specified subscription. Use the nextLink property in the response to get the next page of hybrid machines.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of hybrid machines. ,
Required: True ,
}
[
{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
osProfile:
{
Description: Specifies the operating system settings for the hybrid machine. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the hybrid machine. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
status:
{
Description: The status of the hybrid machine agent. ,
Enum:
{
Connected: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
lastStatusChange:
{
Description: The time of the last status change. ,
Format: date-time ,
Required: False ,
}
string ,
errorDetails:
{
Description: Details about the error state. ,
Required: False ,
}
[
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
agentVersion:
{
Description: The hybrid machine agent full version. ,
Required: False ,
}
string ,
vmId:
{
Description: Specifies the hybrid machine unique ID. ,
Required: False ,
}
string ,
displayName:
{
Description: Specifies the hybrid machine display name. ,
Required: False ,
}
string ,
machineFqdn:
{
Description: Specifies the hybrid machine FQDN. ,
Required: False ,
}
string ,
physicalLocation:
{
Description: Resource's Physical Location ,
Required: False ,
}
string ,
clientPublicKey:
{
Description: Public Key that the client provides to be used during initial resource onboarding ,
Required: False ,
}
string ,
osName:
{
Description: The Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
osVersion:
{
Description: The version of Operating System running on the hybrid machine. ,
Required: False ,
}
string ,
extensions:
{
Description: Machine Extensions information ,
Required: False ,
}
[
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of hybrid machines. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MachineExtensions_CreateOrUpdate (removed)
Description :  The operation to create or update the extension.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine where the extension should be created or updated. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
extensionParameters:
{
Description: Parameters supplied to the Create Machine Extension operation. ,
Required: True ,
}
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}
MachineExtensions_Update (removed)
Description :  The operation to create or update the extension.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine where the extension should be created or updated. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
extensionParameters:
{
Description: Parameters supplied to the Create Machine Extension operation. ,
Required: True ,
}
{
properties:
{
Description: Describes Machine Extension Update Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (202)

{}
MachineExtensions_Delete (removed)
Description :  The operation to delete the extension.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine where the extension should be deleted. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
MachineExtensions_Get (removed)
Description :  The operation to get the extension.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine containing the extension. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
MachineExtensions_List (removed)
Description :  The operation to get all extensions of a non-Azure machine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine containing the extension. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of extensions ,
Required: False ,
}
[
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
instanceView:
{
Description: The machine extension instance view. ,
Required: False ,
}
{
name:
{
Description: The machine extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of machine extensions. Call ListNext() with this to fetch the next page of extensions. ,
Required: False ,
}
string ,
}
Operations_List (removed)
Description :  Gets a list of hybrid compute operations.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of compute operations ,
Required: False ,
}
[
{
origin:
{
Description: The origin of the compute operation. ,
Required: False ,
}
string ,
name:
{
Description: The name of the compute operation. ,
Required: False ,
}
string ,
display:
{
Description: Display properties ,
Required: False ,
}
{
operation:
{
Description: The display name of the compute operation. ,
Required: False ,
}
string ,
resource:
{
Description: The display name of the resource the operation applies to. ,
Required: False ,
}
string ,
description:
{
Description: The description of the operation. ,
Required: False ,
}
string ,
provider:
{
Description: The resource provider for the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}