Microsoft.HybridCompute (preview:2022-08-11)

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

Machines_CreateOrUpdate (new)
Description :  The operation to create or update a hybrid machine. Please note some properties can be set only during machine creation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
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 ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
agentConfiguration:
{
Description: Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. ,
Required: False ,
}
{
proxyUrl:
{
Description: Specifies the URL of the proxy to be used. ,
Required: False ,
}
string ,
incomingConnectionsPorts:
{
Description: Specifies the list of ports that the agent will be able to listen on. ,
Required: False ,
}
[
string ,
]
,
extensionsAllowList:
{
Description: Array of extensions that are allowed to be installed or updated. ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionsBlockList:
{
Description: Array of extensions that are blocked (cannot be installed or updated) ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
proxyBypass:
{
Description: List of service names which should not use the specified proxy server. ,
Required: False ,
}
[
string ,
]
,
extensionsEnabled:
{
Description: Specifies whether the extension service is enabled or disabled. ,
Required: False ,
}
string ,
guestConfigurationEnabled:
{
Description: Specified whether the guest configuration service is enabled or disabled. ,
Required: False ,
}
string ,
configMode:
{
Description: Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft. ,
Enum:
{
full: No description available. ,
monitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
serviceStatuses:
{
Description: Statuses of dependent services that are reported back to ARM. ,
Required: False ,
}
{
extensionService:
{
Description: The state of the extension service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
guestConfigurationService:
{
Description: The state of the guest configuration service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
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 ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
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 code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
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 ,
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 ,
osType:
{
Description: The type of Operating System (windows/linux). ,
Required: False ,
}
string ,
vmUuid:
{
Description: Specifies the Arc Machine's unique SMBIOS ID ,
Required: False ,
}
string ,
osSku:
{
Description: Specifies the Operating System product SKU. ,
Required: False ,
}
string ,
domainName:
{
Description: Specifies the Windows domain name. ,
Required: False ,
}
string ,
adFqdn:
{
Description: Specifies the AD fully qualified display name. ,
Required: False ,
}
string ,
dnsFqdn:
{
Description: Specifies the DNS fully qualified display name. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
mssqlDiscovered:
{
Description: Specifies whether any MS SQL instance is discovered on the machine. ,
Required: False ,
}
string ,
detectedProperties:
{
Description: Detected properties from the machine. ,
Required: False ,
}
object ,
}
,
resources:
{
Description: The list of extensions affiliated to the machine ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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 ,
}
,
}
,
}
,
}
,
]
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
agentConfiguration:
{
Description: Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. ,
Required: False ,
}
{
proxyUrl:
{
Description: Specifies the URL of the proxy to be used. ,
Required: False ,
}
string ,
incomingConnectionsPorts:
{
Description: Specifies the list of ports that the agent will be able to listen on. ,
Required: False ,
}
[
string ,
]
,
extensionsAllowList:
{
Description: Array of extensions that are allowed to be installed or updated. ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionsBlockList:
{
Description: Array of extensions that are blocked (cannot be installed or updated) ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
proxyBypass:
{
Description: List of service names which should not use the specified proxy server. ,
Required: False ,
}
[
string ,
]
,
extensionsEnabled:
{
Description: Specifies whether the extension service is enabled or disabled. ,
Required: False ,
}
string ,
guestConfigurationEnabled:
{
Description: Specified whether the guest configuration service is enabled or disabled. ,
Required: False ,
}
string ,
configMode:
{
Description: Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft. ,
Enum:
{
full: No description available. ,
monitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
serviceStatuses:
{
Description: Statuses of dependent services that are reported back to ARM. ,
Required: False ,
}
{
extensionService:
{
Description: The state of the extension service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
guestConfigurationService:
{
Description: The state of the guest configuration service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
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 ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
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 code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
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 ,
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 ,
osType:
{
Description: The type of Operating System (windows/linux). ,
Required: False ,
}
string ,
vmUuid:
{
Description: Specifies the Arc Machine's unique SMBIOS ID ,
Required: False ,
}
string ,
osSku:
{
Description: Specifies the Operating System product SKU. ,
Required: False ,
}
string ,
domainName:
{
Description: Specifies the Windows domain name. ,
Required: False ,
}
string ,
adFqdn:
{
Description: Specifies the AD fully qualified display name. ,
Required: False ,
}
string ,
dnsFqdn:
{
Description: Specifies the DNS fully qualified display name. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
mssqlDiscovered:
{
Description: Specifies whether any MS SQL instance is discovered on the machine. ,
Required: False ,
}
string ,
detectedProperties:
{
Description: Detected properties from the machine. ,
Required: False ,
}
object ,
}
,
resources:
{
Description: The list of extensions affiliated to the machine ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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 ,
}
,
}
,
}
,
}
,
]
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Machines_Update (new)
Description :  The operation to update a hybrid machine.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update hybrid machine operation. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
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 ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
agentConfiguration:
{
Description: Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. ,
Required: False ,
}
{
proxyUrl:
{
Description: Specifies the URL of the proxy to be used. ,
Required: False ,
}
string ,
incomingConnectionsPorts:
{
Description: Specifies the list of ports that the agent will be able to listen on. ,
Required: False ,
}
[
string ,
]
,
extensionsAllowList:
{
Description: Array of extensions that are allowed to be installed or updated. ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionsBlockList:
{
Description: Array of extensions that are blocked (cannot be installed or updated) ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
proxyBypass:
{
Description: List of service names which should not use the specified proxy server. ,
Required: False ,
}
[
string ,
]
,
extensionsEnabled:
{
Description: Specifies whether the extension service is enabled or disabled. ,
Required: False ,
}
string ,
guestConfigurationEnabled:
{
Description: Specified whether the guest configuration service is enabled or disabled. ,
Required: False ,
}
string ,
configMode:
{
Description: Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft. ,
Enum:
{
full: No description available. ,
monitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
serviceStatuses:
{
Description: Statuses of dependent services that are reported back to ARM. ,
Required: False ,
}
{
extensionService:
{
Description: The state of the extension service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
guestConfigurationService:
{
Description: The state of the guest configuration service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
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 ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
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 code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
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 ,
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 ,
osType:
{
Description: The type of Operating System (windows/linux). ,
Required: False ,
}
string ,
vmUuid:
{
Description: Specifies the Arc Machine's unique SMBIOS ID ,
Required: False ,
}
string ,
osSku:
{
Description: Specifies the Operating System product SKU. ,
Required: False ,
}
string ,
domainName:
{
Description: Specifies the Windows domain name. ,
Required: False ,
}
string ,
adFqdn:
{
Description: Specifies the AD fully qualified display name. ,
Required: False ,
}
string ,
dnsFqdn:
{
Description: Specifies the DNS fully qualified display name. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
mssqlDiscovered:
{
Description: Specifies whether any MS SQL instance is discovered on the machine. ,
Required: False ,
}
string ,
detectedProperties:
{
Description: Detected properties from the machine. ,
Required: False ,
}
object ,
}
,
resources:
{
Description: The list of extensions affiliated to the machine ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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 ,
}
,
}
,
}
,
}
,
]
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Machines_Delete (new)
Description :  The operation to delete a hybrid machine.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
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 ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
agentConfiguration:
{
Description: Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. ,
Required: False ,
}
{
proxyUrl:
{
Description: Specifies the URL of the proxy to be used. ,
Required: False ,
}
string ,
incomingConnectionsPorts:
{
Description: Specifies the list of ports that the agent will be able to listen on. ,
Required: False ,
}
[
string ,
]
,
extensionsAllowList:
{
Description: Array of extensions that are allowed to be installed or updated. ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionsBlockList:
{
Description: Array of extensions that are blocked (cannot be installed or updated) ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
proxyBypass:
{
Description: List of service names which should not use the specified proxy server. ,
Required: False ,
}
[
string ,
]
,
extensionsEnabled:
{
Description: Specifies whether the extension service is enabled or disabled. ,
Required: False ,
}
string ,
guestConfigurationEnabled:
{
Description: Specified whether the guest configuration service is enabled or disabled. ,
Required: False ,
}
string ,
configMode:
{
Description: Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft. ,
Enum:
{
full: No description available. ,
monitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
serviceStatuses:
{
Description: Statuses of dependent services that are reported back to ARM. ,
Required: False ,
}
{
extensionService:
{
Description: The state of the extension service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
guestConfigurationService:
{
Description: The state of the guest configuration service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
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 ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
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 code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
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 ,
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 ,
osType:
{
Description: The type of Operating System (windows/linux). ,
Required: False ,
}
string ,
vmUuid:
{
Description: Specifies the Arc Machine's unique SMBIOS ID ,
Required: False ,
}
string ,
osSku:
{
Description: Specifies the Operating System product SKU. ,
Required: False ,
}
string ,
domainName:
{
Description: Specifies the Windows domain name. ,
Required: False ,
}
string ,
adFqdn:
{
Description: Specifies the AD fully qualified display name. ,
Required: False ,
}
string ,
dnsFqdn:
{
Description: Specifies the DNS fully qualified display name. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
mssqlDiscovered:
{
Description: Specifies whether any MS SQL instance is discovered on the machine. ,
Required: False ,
}
string ,
detectedProperties:
{
Description: Detected properties from the machine. ,
Required: False ,
}
object ,
}
,
resources:
{
Description: The list of extensions affiliated to the machine ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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 ,
}
,
}
,
}
,
}
,
]
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of hybrid machines. ,
Required: True ,
}
[
{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
agentConfiguration:
{
Description: Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. ,
Required: False ,
}
{
proxyUrl:
{
Description: Specifies the URL of the proxy to be used. ,
Required: False ,
}
string ,
incomingConnectionsPorts:
{
Description: Specifies the list of ports that the agent will be able to listen on. ,
Required: False ,
}
[
string ,
]
,
extensionsAllowList:
{
Description: Array of extensions that are allowed to be installed or updated. ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionsBlockList:
{
Description: Array of extensions that are blocked (cannot be installed or updated) ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
proxyBypass:
{
Description: List of service names which should not use the specified proxy server. ,
Required: False ,
}
[
string ,
]
,
extensionsEnabled:
{
Description: Specifies whether the extension service is enabled or disabled. ,
Required: False ,
}
string ,
guestConfigurationEnabled:
{
Description: Specified whether the guest configuration service is enabled or disabled. ,
Required: False ,
}
string ,
configMode:
{
Description: Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft. ,
Enum:
{
full: No description available. ,
monitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
serviceStatuses:
{
Description: Statuses of dependent services that are reported back to ARM. ,
Required: False ,
}
{
extensionService:
{
Description: The state of the extension service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
guestConfigurationService:
{
Description: The state of the guest configuration service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
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 ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
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 code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
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 ,
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 ,
osType:
{
Description: The type of Operating System (windows/linux). ,
Required: False ,
}
string ,
vmUuid:
{
Description: Specifies the Arc Machine's unique SMBIOS ID ,
Required: False ,
}
string ,
osSku:
{
Description: Specifies the Operating System product SKU. ,
Required: False ,
}
string ,
domainName:
{
Description: Specifies the Windows domain name. ,
Required: False ,
}
string ,
adFqdn:
{
Description: Specifies the AD fully qualified display name. ,
Required: False ,
}
string ,
dnsFqdn:
{
Description: Specifies the DNS fully qualified display name. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
mssqlDiscovered:
{
Description: Specifies whether any MS SQL instance is discovered on the machine. ,
Required: False ,
}
string ,
detectedProperties:
{
Description: Detected properties from the machine. ,
Required: False ,
}
object ,
}
,
resources:
{
Description: The list of extensions affiliated to the machine ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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 ,
}
,
}
,
}
,
}
,
]
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of hybrid machines. ,
Required: True ,
}
[
{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
agentConfiguration:
{
Description: Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. ,
Required: False ,
}
{
proxyUrl:
{
Description: Specifies the URL of the proxy to be used. ,
Required: False ,
}
string ,
incomingConnectionsPorts:
{
Description: Specifies the list of ports that the agent will be able to listen on. ,
Required: False ,
}
[
string ,
]
,
extensionsAllowList:
{
Description: Array of extensions that are allowed to be installed or updated. ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionsBlockList:
{
Description: Array of extensions that are blocked (cannot be installed or updated) ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
proxyBypass:
{
Description: List of service names which should not use the specified proxy server. ,
Required: False ,
}
[
string ,
]
,
extensionsEnabled:
{
Description: Specifies whether the extension service is enabled or disabled. ,
Required: False ,
}
string ,
guestConfigurationEnabled:
{
Description: Specified whether the guest configuration service is enabled or disabled. ,
Required: False ,
}
string ,
configMode:
{
Description: Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft. ,
Enum:
{
full: No description available. ,
monitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
serviceStatuses:
{
Description: Statuses of dependent services that are reported back to ARM. ,
Required: False ,
}
{
extensionService:
{
Description: The state of the extension service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
guestConfigurationService:
{
Description: The state of the guest configuration service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
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 ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
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 code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
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 ,
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 ,
osType:
{
Description: The type of Operating System (windows/linux). ,
Required: False ,
}
string ,
vmUuid:
{
Description: Specifies the Arc Machine's unique SMBIOS ID ,
Required: False ,
}
string ,
osSku:
{
Description: Specifies the Operating System product SKU. ,
Required: False ,
}
string ,
domainName:
{
Description: Specifies the Windows domain name. ,
Required: False ,
}
string ,
adFqdn:
{
Description: Specifies the AD fully qualified display name. ,
Required: False ,
}
string ,
dnsFqdn:
{
Description: Specifies the DNS fully qualified display name. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
mssqlDiscovered:
{
Description: Specifies whether any MS SQL instance is discovered on the machine. ,
Required: False ,
}
string ,
detectedProperties:
{
Description: Detected properties from the machine. ,
Required: False ,
}
object ,
}
,
resources:
{
Description: The list of extensions affiliated to the machine ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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 ,
}
,
}
,
}
,
}
,
]
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineExtensions_CreateOrUpdate (new)
Description :  The operation to create or update the extension.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineExtensions_Update (new)
Description :  The operation to create or update the extension.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineExtensions_Delete (new)
Description :  The operation to delete the extension.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineExtensions_Get (new)
Description :  The operation to get the extension.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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 (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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/{machineName}/extensions
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpgradeExtensions (new)
Description :  The operation to Upgrade Machine Extensions.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/upgradeExtensions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
extensionUpgradeParameters:
{
Description: Parameters supplied to the Upgrade Extensions operation. ,
Required: True ,
}
{
extensionTargets:
{
Description: Describes the Extension Target Properties. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExtensionMetadata_Get (new)
Description :  Gets an Extension Metadata based on location, publisher, extensionType and version
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions/{version}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The location of the Extension being received. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the Extension being received. ,
Required: True ,
}
string ,
extensionType:
{
Description: The extensionType of the Extension being received. ,
Required: True ,
}
string ,
version:
{
Description: The version of the Extension being received. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The single extension based on search criteria ,
Required: False ,
}
{
version:
{
Description: The version of the Extension being received. ,
Required: False ,
}
string ,
extensionType:
{
Description: The type of the Extension being received. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the Extension being received. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExtensionMetadata_List (new)
Description :  Gets all Extension versions based on location, publisher, extensionType
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The location of the Extension being received. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the Extension being received. ,
Required: True ,
}
string ,
extensionType:
{
Description: The extensionType of the Extension being received. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of extension metadata ,
Required: False ,
}
[
{
properties:
{
Description: The single extension based on search criteria ,
Required: False ,
}
{
version:
{
Description: The version of the Extension being received. ,
Required: False ,
}
string ,
extensionType:
{
Description: The type of the Extension being received. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the Extension being received. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Gets a list of hybrid compute operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HybridCompute/operations
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}
,
isDataAction:
{
Description: This property indicates if the operation is an action or a data action ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_List (new)
Description :  Gets a list of all Azure Arc PrivateLinkScopes within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/privateLinkScopes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Azure Arc PrivateLinkScope definitions. ,
Required: True ,
}
[
{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to get the next set of Azure Arc PrivateLinkScope definitions if too many PrivateLinkScopes where returned in the result set. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_ListByResourceGroup (new)
Description :  Gets a list of Azure Arc PrivateLinkScopes within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Azure Arc PrivateLinkScope definitions. ,
Required: True ,
}
[
{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to get the next set of Azure Arc PrivateLinkScope definitions if too many PrivateLinkScopes where returned in the result set. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_Delete (new)
Description :  Deletes a Azure Arc PrivateLinkScope.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_Get (new)
Description :  Returns a Azure Arc PrivateLinkScope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_CreateOrUpdate (new)
Description :  Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Properties that need to be specified to create or update a Azure Arc for Servers and Clusters PrivateLinkScope. ,
Required: True ,
}
{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_UpdateTags (new)
Description :  Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
PrivateLinkScopeTags:
{
Description: Updated tag information to set into the PrivateLinkScope instance. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_ListByPrivateLinkScope (new)
Description :  Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: Required DNS zone names of the the private link resource. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (new)
Description :  Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources/{groupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
groupName:
{
Description: The name of the private link resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: Required DNS zone names of the the private link resource. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (new)
Description :  Gets a private endpoint connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (new)
Description :  Approve or reject a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListByPrivateLinkScope (new)
Description :  Gets all private endpoint connections on a private link scope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_GetValidationDetails (new)
Description :  Returns a Azure Arc PrivateLinkScope's validation details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/privateLinkScopes/{privateLinkScopeId}
{
location:
{
Description: The location of the target resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
privateLinkScopeId:
{
Description: The id (Guid) of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Azure resource Id ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
connectionDetails:
{
Description: List of Private Endpoint Connection details. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource Id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private endpoint connection private ip address ,
Required: False ,
}
string ,
linkIdentifier:
{
Description: The private endpoint connection link identifier ,
Required: False ,
}
string ,
groupId:
{
Description: The private endpoint connection group id ,
Required: False ,
}
string ,
memberName:
{
Description: The private endpoint connection member name ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_GetValidationDetailsForMachine (new)
Description :  Returns a Azure Arc PrivateLinkScope's validation details for a given machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/privateLinkScopes/current
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the target machine to get the private link scope validation details for. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Azure resource Id ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
connectionDetails:
{
Description: List of Private Endpoint Connection details. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource Id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private endpoint connection private ip address ,
Required: False ,
}
string ,
linkIdentifier:
{
Description: The private endpoint connection link identifier ,
Required: False ,
}
string ,
groupId:
{
Description: The private endpoint connection group id ,
Required: False ,
}
string ,
memberName:
{
Description: The private endpoint connection member name ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Machines_CreateOrUpdate (removed)
Description :  The operation to create or update a hybrid machine. Please note some properties can be set only during machine creation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
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 ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
agentConfiguration:
{
Description: Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. ,
Required: False ,
}
{
proxyUrl:
{
Description: Specifies the URL of the proxy to be used. ,
Required: False ,
}
string ,
incomingConnectionsPorts:
{
Description: Specifies the list of ports that the agent will be able to listen on. ,
Required: False ,
}
[
string ,
]
,
extensionsAllowList:
{
Description: Array of extensions that are allowed to be installed or updated. ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionsBlockList:
{
Description: Array of extensions that are blocked (cannot be installed or updated) ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
proxyBypass:
{
Description: List of service names which should not use the specified proxy server. ,
Required: False ,
}
[
string ,
]
,
extensionsEnabled:
{
Description: Specifies whether the extension service is enabled or disabled. ,
Required: False ,
}
string ,
guestConfigurationEnabled:
{
Description: Specified whether the guest configuration service is enabled or disabled. ,
Required: False ,
}
string ,
configMode:
{
Description: Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft. ,
Enum:
{
full: No description available. ,
monitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
serviceStatuses:
{
Description: Statuses of dependent services that are reported back to ARM. ,
Required: False ,
}
{
extensionService:
{
Description: The state of the extension service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
guestConfigurationService:
{
Description: The state of the guest configuration service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
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 ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
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 code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
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 ,
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 ,
osType:
{
Description: The type of Operating System (windows/linux). ,
Required: False ,
}
string ,
vmUuid:
{
Description: Specifies the Arc Machine's unique SMBIOS ID ,
Required: False ,
}
string ,
osSku:
{
Description: Specifies the Operating System product SKU. ,
Required: False ,
}
string ,
domainName:
{
Description: Specifies the Windows domain name. ,
Required: False ,
}
string ,
adFqdn:
{
Description: Specifies the AD fully qualified display name. ,
Required: False ,
}
string ,
dnsFqdn:
{
Description: Specifies the DNS fully qualified display name. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
mssqlDiscovered:
{
Description: Specifies whether any MS SQL instance is discovered on the machine. ,
Required: False ,
}
string ,
detectedProperties:
{
Description: Detected properties from the machine. ,
Required: False ,
}
object ,
}
,
resources:
{
Description: The list of extensions affiliated to the machine ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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 ,
}
,
}
,
}
,
}
,
]
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
agentConfiguration:
{
Description: Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. ,
Required: False ,
}
{
proxyUrl:
{
Description: Specifies the URL of the proxy to be used. ,
Required: False ,
}
string ,
incomingConnectionsPorts:
{
Description: Specifies the list of ports that the agent will be able to listen on. ,
Required: False ,
}
[
string ,
]
,
extensionsAllowList:
{
Description: Array of extensions that are allowed to be installed or updated. ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionsBlockList:
{
Description: Array of extensions that are blocked (cannot be installed or updated) ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
proxyBypass:
{
Description: List of service names which should not use the specified proxy server. ,
Required: False ,
}
[
string ,
]
,
extensionsEnabled:
{
Description: Specifies whether the extension service is enabled or disabled. ,
Required: False ,
}
string ,
guestConfigurationEnabled:
{
Description: Specified whether the guest configuration service is enabled or disabled. ,
Required: False ,
}
string ,
configMode:
{
Description: Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft. ,
Enum:
{
full: No description available. ,
monitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
serviceStatuses:
{
Description: Statuses of dependent services that are reported back to ARM. ,
Required: False ,
}
{
extensionService:
{
Description: The state of the extension service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
guestConfigurationService:
{
Description: The state of the guest configuration service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
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 ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
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 code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
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 ,
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 ,
osType:
{
Description: The type of Operating System (windows/linux). ,
Required: False ,
}
string ,
vmUuid:
{
Description: Specifies the Arc Machine's unique SMBIOS ID ,
Required: False ,
}
string ,
osSku:
{
Description: Specifies the Operating System product SKU. ,
Required: False ,
}
string ,
domainName:
{
Description: Specifies the Windows domain name. ,
Required: False ,
}
string ,
adFqdn:
{
Description: Specifies the AD fully qualified display name. ,
Required: False ,
}
string ,
dnsFqdn:
{
Description: Specifies the DNS fully qualified display name. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
mssqlDiscovered:
{
Description: Specifies whether any MS SQL instance is discovered on the machine. ,
Required: False ,
}
string ,
detectedProperties:
{
Description: Detected properties from the machine. ,
Required: False ,
}
object ,
}
,
resources:
{
Description: The list of extensions affiliated to the machine ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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 ,
}
,
}
,
}
,
}
,
]
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Machines_Update (removed)
Description :  The operation to update a hybrid machine.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update hybrid machine operation. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
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 ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
agentConfiguration:
{
Description: Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. ,
Required: False ,
}
{
proxyUrl:
{
Description: Specifies the URL of the proxy to be used. ,
Required: False ,
}
string ,
incomingConnectionsPorts:
{
Description: Specifies the list of ports that the agent will be able to listen on. ,
Required: False ,
}
[
string ,
]
,
extensionsAllowList:
{
Description: Array of extensions that are allowed to be installed or updated. ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionsBlockList:
{
Description: Array of extensions that are blocked (cannot be installed or updated) ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
proxyBypass:
{
Description: List of service names which should not use the specified proxy server. ,
Required: False ,
}
[
string ,
]
,
extensionsEnabled:
{
Description: Specifies whether the extension service is enabled or disabled. ,
Required: False ,
}
string ,
guestConfigurationEnabled:
{
Description: Specified whether the guest configuration service is enabled or disabled. ,
Required: False ,
}
string ,
configMode:
{
Description: Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft. ,
Enum:
{
full: No description available. ,
monitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
serviceStatuses:
{
Description: Statuses of dependent services that are reported back to ARM. ,
Required: False ,
}
{
extensionService:
{
Description: The state of the extension service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
guestConfigurationService:
{
Description: The state of the guest configuration service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
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 ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
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 code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
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 ,
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 ,
osType:
{
Description: The type of Operating System (windows/linux). ,
Required: False ,
}
string ,
vmUuid:
{
Description: Specifies the Arc Machine's unique SMBIOS ID ,
Required: False ,
}
string ,
osSku:
{
Description: Specifies the Operating System product SKU. ,
Required: False ,
}
string ,
domainName:
{
Description: Specifies the Windows domain name. ,
Required: False ,
}
string ,
adFqdn:
{
Description: Specifies the AD fully qualified display name. ,
Required: False ,
}
string ,
dnsFqdn:
{
Description: Specifies the DNS fully qualified display name. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
mssqlDiscovered:
{
Description: Specifies whether any MS SQL instance is discovered on the machine. ,
Required: False ,
}
string ,
detectedProperties:
{
Description: Detected properties from the machine. ,
Required: False ,
}
object ,
}
,
resources:
{
Description: The list of extensions affiliated to the machine ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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 ,
}
,
}
,
}
,
}
,
]
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Machines_Delete (removed)
Description :  The operation to delete a hybrid machine.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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/{machineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
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 ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
agentConfiguration:
{
Description: Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. ,
Required: False ,
}
{
proxyUrl:
{
Description: Specifies the URL of the proxy to be used. ,
Required: False ,
}
string ,
incomingConnectionsPorts:
{
Description: Specifies the list of ports that the agent will be able to listen on. ,
Required: False ,
}
[
string ,
]
,
extensionsAllowList:
{
Description: Array of extensions that are allowed to be installed or updated. ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionsBlockList:
{
Description: Array of extensions that are blocked (cannot be installed or updated) ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
proxyBypass:
{
Description: List of service names which should not use the specified proxy server. ,
Required: False ,
}
[
string ,
]
,
extensionsEnabled:
{
Description: Specifies whether the extension service is enabled or disabled. ,
Required: False ,
}
string ,
guestConfigurationEnabled:
{
Description: Specified whether the guest configuration service is enabled or disabled. ,
Required: False ,
}
string ,
configMode:
{
Description: Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft. ,
Enum:
{
full: No description available. ,
monitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
serviceStatuses:
{
Description: Statuses of dependent services that are reported back to ARM. ,
Required: False ,
}
{
extensionService:
{
Description: The state of the extension service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
guestConfigurationService:
{
Description: The state of the guest configuration service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
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 ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
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 code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
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 ,
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 ,
osType:
{
Description: The type of Operating System (windows/linux). ,
Required: False ,
}
string ,
vmUuid:
{
Description: Specifies the Arc Machine's unique SMBIOS ID ,
Required: False ,
}
string ,
osSku:
{
Description: Specifies the Operating System product SKU. ,
Required: False ,
}
string ,
domainName:
{
Description: Specifies the Windows domain name. ,
Required: False ,
}
string ,
adFqdn:
{
Description: Specifies the AD fully qualified display name. ,
Required: False ,
}
string ,
dnsFqdn:
{
Description: Specifies the DNS fully qualified display name. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
mssqlDiscovered:
{
Description: Specifies whether any MS SQL instance is discovered on the machine. ,
Required: False ,
}
string ,
detectedProperties:
{
Description: Detected properties from the machine. ,
Required: False ,
}
object ,
}
,
resources:
{
Description: The list of extensions affiliated to the machine ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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 ,
}
,
}
,
}
,
}
,
]
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of hybrid machines. ,
Required: True ,
}
[
{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
agentConfiguration:
{
Description: Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. ,
Required: False ,
}
{
proxyUrl:
{
Description: Specifies the URL of the proxy to be used. ,
Required: False ,
}
string ,
incomingConnectionsPorts:
{
Description: Specifies the list of ports that the agent will be able to listen on. ,
Required: False ,
}
[
string ,
]
,
extensionsAllowList:
{
Description: Array of extensions that are allowed to be installed or updated. ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionsBlockList:
{
Description: Array of extensions that are blocked (cannot be installed or updated) ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
proxyBypass:
{
Description: List of service names which should not use the specified proxy server. ,
Required: False ,
}
[
string ,
]
,
extensionsEnabled:
{
Description: Specifies whether the extension service is enabled or disabled. ,
Required: False ,
}
string ,
guestConfigurationEnabled:
{
Description: Specified whether the guest configuration service is enabled or disabled. ,
Required: False ,
}
string ,
configMode:
{
Description: Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft. ,
Enum:
{
full: No description available. ,
monitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
serviceStatuses:
{
Description: Statuses of dependent services that are reported back to ARM. ,
Required: False ,
}
{
extensionService:
{
Description: The state of the extension service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
guestConfigurationService:
{
Description: The state of the guest configuration service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
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 ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
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 code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
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 ,
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 ,
osType:
{
Description: The type of Operating System (windows/linux). ,
Required: False ,
}
string ,
vmUuid:
{
Description: Specifies the Arc Machine's unique SMBIOS ID ,
Required: False ,
}
string ,
osSku:
{
Description: Specifies the Operating System product SKU. ,
Required: False ,
}
string ,
domainName:
{
Description: Specifies the Windows domain name. ,
Required: False ,
}
string ,
adFqdn:
{
Description: Specifies the AD fully qualified display name. ,
Required: False ,
}
string ,
dnsFqdn:
{
Description: Specifies the DNS fully qualified display name. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
mssqlDiscovered:
{
Description: Specifies whether any MS SQL instance is discovered on the machine. ,
Required: False ,
}
string ,
detectedProperties:
{
Description: Detected properties from the machine. ,
Required: False ,
}
object ,
}
,
resources:
{
Description: The list of extensions affiliated to the machine ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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 ,
}
,
}
,
}
,
}
,
]
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of hybrid machines. ,
Required: True ,
}
[
{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
{
locationData:
{
Description: Metadata pertaining to the geographic location of the resource. ,
Required: False ,
}
{
name:
{
Description: A canonical name for the geographic or physical location. ,
Required: True ,
}
string ,
city:
{
Description: The city or locality where the resource is located. ,
Required: False ,
}
string ,
district:
{
Description: The district, state, or province where the resource is located. ,
Required: False ,
}
string ,
countryOrRegion:
{
Description: The country or region where the resource is located ,
Required: False ,
}
string ,
}
,
agentConfiguration:
{
Description: Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. ,
Required: False ,
}
{
proxyUrl:
{
Description: Specifies the URL of the proxy to be used. ,
Required: False ,
}
string ,
incomingConnectionsPorts:
{
Description: Specifies the list of ports that the agent will be able to listen on. ,
Required: False ,
}
[
string ,
]
,
extensionsAllowList:
{
Description: Array of extensions that are allowed to be installed or updated. ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionsBlockList:
{
Description: Array of extensions that are blocked (cannot be installed or updated) ,
Required: False ,
}
[
{
publisher:
{
Description: Publisher of the extension. ,
Required: False ,
}
string ,
type:
{
Description: Type of the extension. ,
Required: False ,
}
string ,
}
,
]
,
proxyBypass:
{
Description: List of service names which should not use the specified proxy server. ,
Required: False ,
}
[
string ,
]
,
extensionsEnabled:
{
Description: Specifies whether the extension service is enabled or disabled. ,
Required: False ,
}
string ,
guestConfigurationEnabled:
{
Description: Specified whether the guest configuration service is enabled or disabled. ,
Required: False ,
}
string ,
configMode:
{
Description: Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft. ,
Enum:
{
full: No description available. ,
monitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
serviceStatuses:
{
Description: Statuses of dependent services that are reported back to ARM. ,
Required: False ,
}
{
extensionService:
{
Description: The state of the extension service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
guestConfigurationService:
{
Description: The state of the guest configuration service on the Arc-enabled machine. ,
Required: False ,
}
{
status:
{
Description: The current status of the service. ,
Required: False ,
}
string ,
startupType:
{
Description: The behavior of the service when the Arc-enabled machine starts up. ,
Required: False ,
}
string ,
}
,
}
,
cloudMetadata:
{
Description: The metadata of the cloud environment (Azure/GCP/AWS/OCI...). ,
Required: False ,
}
{
provider:
{
Description: Specifies the cloud provider (Azure/AWS/GCP...). ,
Required: False ,
}
string ,
}
,
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 ,
windowsConfiguration:
{
Description: Specifies the windows configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
linuxConfiguration:
{
Description: Specifies the linux configuration for update management. ,
Required: False ,
}
{
patchSettings:
{
Description: Specifies the patch settings. ,
Required: False ,
}
{
assessmentMode:
{
Description: Specifies the assessment mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
}
,
Required: False ,
}
enum ,
patchMode:
{
Description: Specifies the patch mode. ,
Enum:
{
ImageDefault: No description available. ,
AutomaticByPlatform: No description available. ,
AutomaticByOS: No description available. ,
Manual: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
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 code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
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 ,
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 ,
osType:
{
Description: The type of Operating System (windows/linux). ,
Required: False ,
}
string ,
vmUuid:
{
Description: Specifies the Arc Machine's unique SMBIOS ID ,
Required: False ,
}
string ,
osSku:
{
Description: Specifies the Operating System product SKU. ,
Required: False ,
}
string ,
domainName:
{
Description: Specifies the Windows domain name. ,
Required: False ,
}
string ,
adFqdn:
{
Description: Specifies the AD fully qualified display name. ,
Required: False ,
}
string ,
dnsFqdn:
{
Description: Specifies the DNS fully qualified display name. ,
Required: False ,
}
string ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Required: False ,
}
string ,
parentClusterResourceId:
{
Description: The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. ,
Required: False ,
}
string ,
mssqlDiscovered:
{
Description: Specifies whether any MS SQL instance is discovered on the machine. ,
Required: False ,
}
string ,
detectedProperties:
{
Description: Detected properties from the machine. ,
Required: False ,
}
object ,
}
,
resources:
{
Description: The list of extensions affiliated to the machine ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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 ,
}
,
}
,
}
,
}
,
]
,
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineExtensions_CreateOrUpdate (removed)
Description :  The operation to create or update the extension.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineExtensions_Update (removed)
Description :  The operation to create or update the extension.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineExtensions_Delete (removed)
Description :  The operation to delete the extension.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MachineExtensions_Get (removed)
Description :  The operation to get the extension.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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 (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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/{machineName}/extensions
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpgradeExtensions (removed)
Description :  The operation to Upgrade Machine Extensions.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/upgradeExtensions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
extensionUpgradeParameters:
{
Description: Parameters supplied to the Upgrade Extensions operation. ,
Required: True ,
}
{
extensionTargets:
{
Description: Describes the Extension Target Properties. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExtensionMetadata_Get (removed)
Description :  Gets an Extension Metadata based on location, publisher, extensionType and version
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions/{version}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The location of the Extension being received. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the Extension being received. ,
Required: True ,
}
string ,
extensionType:
{
Description: The extensionType of the Extension being received. ,
Required: True ,
}
string ,
version:
{
Description: The version of the Extension being received. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The single extension based on search criteria ,
Required: False ,
}
{
version:
{
Description: The version of the Extension being received. ,
Required: False ,
}
string ,
extensionType:
{
Description: The type of the Extension being received. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the Extension being received. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExtensionMetadata_List (removed)
Description :  Gets all Extension versions based on location, publisher, extensionType
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The location of the Extension being received. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the Extension being received. ,
Required: True ,
}
string ,
extensionType:
{
Description: The extensionType of the Extension being received. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of extension metadata ,
Required: False ,
}
[
{
properties:
{
Description: The single extension based on search criteria ,
Required: False ,
}
{
version:
{
Description: The version of the Extension being received. ,
Required: False ,
}
string ,
extensionType:
{
Description: The type of the Extension being received. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the Extension being received. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Gets a list of hybrid compute operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HybridCompute/operations
{
api-version:
{
Description: The API version to use for this operation. ,
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 ,
}
,
isDataAction:
{
Description: This property indicates if the operation is an action or a data action ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_List (removed)
Description :  Gets a list of all Azure Arc PrivateLinkScopes within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/privateLinkScopes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Azure Arc PrivateLinkScope definitions. ,
Required: True ,
}
[
{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to get the next set of Azure Arc PrivateLinkScope definitions if too many PrivateLinkScopes where returned in the result set. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_ListByResourceGroup (removed)
Description :  Gets a list of Azure Arc PrivateLinkScopes within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Azure Arc PrivateLinkScope definitions. ,
Required: True ,
}
[
{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to get the next set of Azure Arc PrivateLinkScope definitions if too many PrivateLinkScopes where returned in the result set. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_Delete (removed)
Description :  Deletes a Azure Arc PrivateLinkScope.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_Get (removed)
Description :  Returns a Azure Arc PrivateLinkScope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_CreateOrUpdate (removed)
Description :  Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Properties that need to be specified to create or update a Azure Arc for Servers and Clusters PrivateLinkScope. ,
Required: True ,
}
{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_UpdateTags (removed)
Description :  Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
PrivateLinkScopeTags:
{
Description: Updated tag information to set into the PrivateLinkScope instance. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties that define a Azure Arc PrivateLinkScope resource. ,
Required: False ,
}
{
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. ,
Required: False ,
}
string ,
privateLinkScopeId:
{
Description: The Guid id of the private link scope. ,
Required: False ,
}
string ,
privateEndpointConnections:
{
Description: The collection of associated Private Endpoint Connections. ,
Required: False ,
}
[
{
id:
{
Description: The ARM Resource Id of the Private Endpoint. ,
Required: False ,
}
string ,
name:
{
Description: The Name of the Private Endpoint. ,
Required: False ,
}
string ,
type:
{
Description: Azure resource type ,
Required: False ,
}
string ,
properties:
{
Description: The Private Endpoint Connection properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_ListByPrivateLinkScope (removed)
Description :  Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: Required DNS zone names of the the private link resource. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (removed)
Description :  Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources/{groupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
groupName:
{
Description: The name of the private link resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: Required DNS zone names of the the private link resource. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (removed)
Description :  Gets a private endpoint connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (removed)
Description :  Approve or reject a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (removed)
Description :  Deletes a private endpoint connection with a given name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListByPrivateLinkScope (removed)
Description :  Gets all private endpoint connections on a private link scope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
scopeName:
{
Description: The name of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of results. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: Private endpoint which the connection belongs to. ,
Required: False ,
}
{
id:
{
Description: Resource id of the private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: Connection state of the private endpoint connection. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Required: True ,
}
string ,
description:
{
Description: The private link service connection description. ,
Required: True ,
}
string ,
actionsRequired:
{
Description: The actions required for private link service connection. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
groupIds:
{
Description: List of group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
systemData:
{
Description: The system meta data relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to retrieve next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_GetValidationDetails (removed)
Description :  Returns a Azure Arc PrivateLinkScope's validation details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/privateLinkScopes/{privateLinkScopeId}
{
location:
{
Description: The location of the target resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
privateLinkScopeId:
{
Description: The id (Guid) of the Azure Arc PrivateLinkScope resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Azure resource Id ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
connectionDetails:
{
Description: List of Private Endpoint Connection details. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource Id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private endpoint connection private ip address ,
Required: False ,
}
string ,
linkIdentifier:
{
Description: The private endpoint connection link identifier ,
Required: False ,
}
string ,
groupId:
{
Description: The private endpoint connection group id ,
Required: False ,
}
string ,
memberName:
{
Description: The private endpoint connection member name ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkScopes_GetValidationDetailsForMachine (removed)
Description :  Returns a Azure Arc PrivateLinkScope's validation details for a given machine.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/privateLinkScopes/current
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
machineName:
{
Description: The name of the target machine to get the private link scope validation details for. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Azure resource Id ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. ,
Enum:
{
Enabled: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints. ,
Disabled: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link. ,
}
,
Required: False ,
}
enum ,
connectionDetails:
{
Description: List of Private Endpoint Connection details. ,
Required: False ,
}
[
{
id:
{
Description: Azure resource Id ,
Required: False ,
}
string ,
privateIpAddress:
{
Description: The private endpoint connection private ip address ,
Required: False ,
}
string ,
linkIdentifier:
{
Description: The private endpoint connection link identifier ,
Required: False ,
}
string ,
groupId:
{
Description: The private endpoint connection group id ,
Required: False ,
}
string ,
memberName:
{
Description: The private endpoint connection member name ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}