Microsoft.HybridCompute (preview:2020-08-15)

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

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}
{
api-version:
{
Description: 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. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create hybrid machine operation. ,
Required: True ,
}
{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}
{
api-version:
{
Description: 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. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update hybrid machine operation. ,
Required: True ,
}
{
identity:
{
Description: Hybrid Compute Machine Managed Identity ,
Required: False ,
}
string ,
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}
{
api-version:
{
Description: 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. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}
{
api-version:
{
Description: 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. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/assessPatches
{
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. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentActivityId:
{
Description: The activity ID of the operation that produced this result. ,
Required: False ,
}
string ,
rebootPending:
{
Description: The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. ,
Required: False ,
}
boolean ,
availablePatchCountByClassification:
{
Description: Summarization of patches available for installation on the machine by classification. ,
Required: False ,
}
{
security:
{
Description: Number of security patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
critical:
{
Description: Number of critical patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
definition:
{
Description: Number of definition patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
updateRollup:
{
Description: Number of update Rollup patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
featurePack:
{
Description: Number of feature pack patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
servicePack:
{
Description: Number of service pack patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
tools:
{
Description: Number of tools patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
updates:
{
Description: Number of updates category patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
other:
{
Description: Number of other patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
startDateTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The UTC timestamp when the operation finished. ,
Format: date-time ,
Required: False ,
}
string ,
startedBy:
{
Description: Indicates if operation was triggered by user or by platform. ,
Enum:
{
User: No description available. ,
Platform: No description available. ,
}
,
Required: False ,
}
enum ,
patchServiceUsed:
{
Description: Specifies the patch service used for the operation. ,
Enum:
{
Unknown: No description available. ,
WU: No description available. ,
WU_WSUS: No description available. ,
YUM: No description available. ,
APT: No description available. ,
Zypper: No description available. ,
}
,
Required: False ,
}
enum ,
osType:
{
Description: The operating system type of the machine. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
Required: False ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/installPatches
{
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. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
installPatchesInput:
{
Description: Input for InstallPatches as directly received by the API ,
Required: True ,
}
{
maximumDuration:
{
Description: Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours) ,
Required: True ,
}
string ,
rebootSetting:
{
Description: Defines when it is acceptable to reboot a VM during a software update operation. ,
Enum:
{
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: True ,
}
enum ,
windowsParameters:
{
Description: Input for InstallPatches on a Windows VM, as directly received by the API ,
Required: False ,
}
{
classificationsToInclude:
{
Description: The update classifications to select when installing patches for Windows. ,
Required: False ,
}
[
string ,
]
,
kbNumbersToInclude:
{
Description: Kbs to include in the patch operation ,
Required: False ,
}
[
string ,
]
,
kbNumbersToExclude:
{
Description: Kbs to exclude in the patch operation ,
Required: False ,
}
[
string ,
]
,
excludeKbsRequiringReboot:
{
Description: Filters out Kbs that don't have an InstallationRebootBehavior of 'NeverReboots' when this is set to true. ,
Required: False ,
}
boolean ,
maxPatchPublishDate:
{
Description: This is used to install patches that were published on or before this given max published date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
linuxParameters:
{
Description: Input for InstallPatches on a Linux VM, as directly received by the API ,
Required: False ,
}
{
classificationsToInclude:
{
Description: The update classifications to select when installing patches for Linux. ,
Required: False ,
}
[
string ,
]
,
packageNameMasksToInclude:
{
Description: packages to include in the patch operation. Format: packageName_packageVersion ,
Required: False ,
}
[
string ,
]
,
packageNameMasksToExclude:
{
Description: packages to exclude in the patch operation. Format: packageName_packageVersion ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Failed", "Succeeded", "Unknown" or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
installationActivityId:
{
Description: The activity ID of the operation that produced this result. ,
Required: False ,
}
string ,
rebootStatus:
{
Description: The reboot state of the VM following completion of the operation. ,
Enum:
{
Unknown: No description available. ,
NotNeeded: No description available. ,
Required: No description available. ,
Started: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindowExceeded:
{
Description: Whether the operation ran out of time before it completed all its intended actions. ,
Required: False ,
}
boolean ,
excludedPatchCount:
{
Description: The number of patches that were not installed due to the user blocking their installation. ,
Format: int32 ,
Required: False ,
}
integer ,
notSelectedPatchCount:
{
Description: The number of patches that were detected as available for install, but did not meet the operation's criteria. ,
Format: int32 ,
Required: False ,
}
integer ,
pendingPatchCount:
{
Description: The number of patches that were identified as meeting the installation criteria, but were not able to be installed. Typically this happens when maintenanceWindowExceeded == true. ,
Format: int32 ,
Required: False ,
}
integer ,
installedPatchCount:
{
Description: The number of patches successfully installed. ,
Format: int32 ,
Required: False ,
}
integer ,
failedPatchCount:
{
Description: The number of patches that could not be installed due to some issue. See errors for details. ,
Format: int32 ,
Required: False ,
}
integer ,
startDateTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The UTC timestamp when the operation finished. ,
Format: date-time ,
Required: False ,
}
string ,
startedBy:
{
Description: Indicates if operation was triggered by user or by platform. ,
Enum:
{
User: No description available. ,
Platform: No description available. ,
}
,
Required: False ,
}
enum ,
patchServiceUsed:
{
Description: Specifies the patch service used for the operation. ,
Enum:
{
Unknown: No description available. ,
WU: No description available. ,
WU_WSUS: No description available. ,
YUM: No description available. ,
APT: No description available. ,
Zypper: No description available. ,
}
,
Required: False ,
}
enum ,
osType:
{
Description: The operating system type of the machine. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
Required: False ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines
{
api-version:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of hybrid machines. ,
Required: True ,
}
[
{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of hybrid machines. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/machines
{
api-version:
{
Description: 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 ,
}
string ,
identity:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of hybrid machines. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine where the extension should be created or updated. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
extensionParameters:
{
Description: Parameters supplied to the Create Machine Extension operation. ,
Required: True ,
}
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
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 ,
}
string ,
}

⚐ Response (202)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine where the extension should be created or updated. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
extensionParameters:
{
Description: Parameters supplied to the Create Machine Extension operation. ,
Required: True ,
}
{
properties:
{
Description: Describes Machine Extension Update Properties. ,
Required: False ,
}
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 ,
}
string ,
}

⚐ Response (202)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine where the extension should be deleted. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
api-version:
{
Description: 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)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine containing the extension. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
api-version:
{
Description: 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 ,
}
string ,
}
MachineExtensions_List (new)
Description :  The operation to get all extensions of a non-Azure machine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine containing the extension. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: 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 ,
}
string ,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of machine extensions. Call ListNext() with this to fetch the next page of extensions. ,
Required: False ,
}
string ,
}
Operations_List (new)
Description :  Gets a list of hybrid compute operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HybridCompute/operations
{
api-version:
{
Description: 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 ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
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 ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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. ,
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 ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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. ,
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 ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
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. ,
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 ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
}
,
]
,
}
,
}
,
}

⚐ 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 ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
}
,
]
,
}
,
}

⚐ 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 ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
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. ,
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 ,
}
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 ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
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. ,
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 ,
]
,
}
,
}
,
]
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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. ,
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 ,
]
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
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. ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
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. ,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
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. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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. ,
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 ,
}
,
}
,
]
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
PrivateLinkScopedResources_Get (new)
Description :  Gets a scoped resource in a private link scope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/scopedResources/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
name:
{
Description: The name of the scoped resource object. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
linkedResourceId:
{
Description: The resource id of the scoped Azure monitor resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: State of the private endpoint connection. ,
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 ,
}
,
]
,
}
,
}
PrivateLinkScopedResources_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}/scopedResources/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
name:
{
Description: The name of the scoped resource object. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
linkedResourceId:
{
Description: The resource id of the scoped Azure monitor resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
linkedResourceId:
{
Description: The resource id of the scoped Azure monitor resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
linkedResourceId:
{
Description: The resource id of the scoped Azure monitor resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: State of the private endpoint connection. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
PrivateLinkScopedResources_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}/scopedResources/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
name:
{
Description: The name of the scoped resource object. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
PrivateLinkScopedResources_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}/scopedResources
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
}
{
linkedResourceId:
{
Description: The resource id of the scoped Azure monitor resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: State of the private endpoint connection. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
Machines_CreateOrUpdate (removed)
Description :  The operation to create or update a hybrid machine resource identity in Azure.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}
{
api-version:
{
Description: 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. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create hybrid machine operation. ,
Required: True ,
}
{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}
{
api-version:
{
Description: 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. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update hybrid machine operation. ,
Required: True ,
}
{
identity:
{
Description: Hybrid Compute Machine Managed Identity ,
Required: False ,
}
string ,
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}
{
api-version:
{
Description: 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. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}
{
api-version:
{
Description: 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. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/assessPatches
{
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. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
assessmentActivityId:
{
Description: The activity ID of the operation that produced this result. ,
Required: False ,
}
string ,
rebootPending:
{
Description: The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. ,
Required: False ,
}
boolean ,
availablePatchCountByClassification:
{
Description: Summarization of patches available for installation on the machine by classification. ,
Required: False ,
}
{
security:
{
Description: Number of security patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
critical:
{
Description: Number of critical patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
definition:
{
Description: Number of definition patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
updateRollup:
{
Description: Number of update Rollup patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
featurePack:
{
Description: Number of feature pack patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
servicePack:
{
Description: Number of service pack patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
tools:
{
Description: Number of tools patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
updates:
{
Description: Number of updates category patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
other:
{
Description: Number of other patches available for installation. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
startDateTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The UTC timestamp when the operation finished. ,
Format: date-time ,
Required: False ,
}
string ,
startedBy:
{
Description: Indicates if operation was triggered by user or by platform. ,
Enum:
{
User: No description available. ,
Platform: No description available. ,
}
,
Required: False ,
}
enum ,
patchServiceUsed:
{
Description: Specifies the patch service used for the operation. ,
Enum:
{
Unknown: No description available. ,
WU: No description available. ,
WU_WSUS: No description available. ,
YUM: No description available. ,
APT: No description available. ,
Zypper: No description available. ,
}
,
Required: False ,
}
enum ,
osType:
{
Description: The operating system type of the machine. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
Required: False ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/installPatches
{
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. ,
Required: True ,
}
string ,
name:
{
Description: The name of the hybrid machine. ,
Required: True ,
}
string ,
installPatchesInput:
{
Description: Input for InstallPatches as directly received by the API ,
Required: True ,
}
{
maximumDuration:
{
Description: Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours) ,
Required: True ,
}
string ,
rebootSetting:
{
Description: Defines when it is acceptable to reboot a VM during a software update operation. ,
Enum:
{
IfRequired: No description available. ,
Never: No description available. ,
Always: No description available. ,
}
,
Required: True ,
}
enum ,
windowsParameters:
{
Description: Input for InstallPatches on a Windows VM, as directly received by the API ,
Required: False ,
}
{
classificationsToInclude:
{
Description: The update classifications to select when installing patches for Windows. ,
Required: False ,
}
[
string ,
]
,
kbNumbersToInclude:
{
Description: Kbs to include in the patch operation ,
Required: False ,
}
[
string ,
]
,
kbNumbersToExclude:
{
Description: Kbs to exclude in the patch operation ,
Required: False ,
}
[
string ,
]
,
excludeKbsRequiringReboot:
{
Description: Filters out Kbs that don't have an InstallationRebootBehavior of 'NeverReboots' when this is set to true. ,
Required: False ,
}
boolean ,
maxPatchPublishDate:
{
Description: This is used to install patches that were published on or before this given max published date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
linuxParameters:
{
Description: Input for InstallPatches on a Linux VM, as directly received by the API ,
Required: False ,
}
{
classificationsToInclude:
{
Description: The update classifications to select when installing patches for Linux. ,
Required: False ,
}
[
string ,
]
,
packageNameMasksToInclude:
{
Description: packages to include in the patch operation. Format: packageName_packageVersion ,
Required: False ,
}
[
string ,
]
,
packageNameMasksToExclude:
{
Description: packages to exclude in the patch operation. Format: packageName_packageVersion ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
status:
{
Description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Failed", "Succeeded", "Unknown" or "CompletedWithWarnings." ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
CompletedWithWarnings: No description available. ,
}
,
Required: False ,
}
enum ,
installationActivityId:
{
Description: The activity ID of the operation that produced this result. ,
Required: False ,
}
string ,
rebootStatus:
{
Description: The reboot state of the VM following completion of the operation. ,
Enum:
{
Unknown: No description available. ,
NotNeeded: No description available. ,
Required: No description available. ,
Started: No description available. ,
Failed: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
maintenanceWindowExceeded:
{
Description: Whether the operation ran out of time before it completed all its intended actions. ,
Required: False ,
}
boolean ,
excludedPatchCount:
{
Description: The number of patches that were not installed due to the user blocking their installation. ,
Format: int32 ,
Required: False ,
}
integer ,
notSelectedPatchCount:
{
Description: The number of patches that were detected as available for install, but did not meet the operation's criteria. ,
Format: int32 ,
Required: False ,
}
integer ,
pendingPatchCount:
{
Description: The number of patches that were identified as meeting the installation criteria, but were not able to be installed. Typically this happens when maintenanceWindowExceeded == true. ,
Format: int32 ,
Required: False ,
}
integer ,
installedPatchCount:
{
Description: The number of patches successfully installed. ,
Format: int32 ,
Required: False ,
}
integer ,
failedPatchCount:
{
Description: The number of patches that could not be installed due to some issue. See errors for details. ,
Format: int32 ,
Required: False ,
}
integer ,
startDateTime:
{
Description: The UTC timestamp when the operation began. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The UTC timestamp when the operation finished. ,
Format: date-time ,
Required: False ,
}
string ,
startedBy:
{
Description: Indicates if operation was triggered by user or by platform. ,
Enum:
{
User: No description available. ,
Platform: No description available. ,
}
,
Required: False ,
}
enum ,
patchServiceUsed:
{
Description: Specifies the patch service used for the operation. ,
Enum:
{
Unknown: No description available. ,
WU: No description available. ,
WU_WSUS: No description available. ,
YUM: No description available. ,
APT: No description available. ,
Zypper: No description available. ,
}
,
Required: False ,
}
enum ,
osType:
{
Description: The operating system type of the machine. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: The errors that were encountered during execution of the operation. The details array contains the list of them. ,
Required: False ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines
{
api-version:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of hybrid machines. ,
Required: True ,
}
[
{
properties:
{
Description: Hybrid Compute Machine properties ,
Required: False ,
}
string ,
identity:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of hybrid machines. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/machines
{
api-version:
{
Description: 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 ,
}
string ,
identity:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of hybrid machines. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine where the extension should be created or updated. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
extensionParameters:
{
Description: Parameters supplied to the Create Machine Extension operation. ,
Required: True ,
}
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
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 ,
}
string ,
}

⚐ Response (202)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine where the extension should be created or updated. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
extensionParameters:
{
Description: Parameters supplied to the Create Machine Extension operation. ,
Required: True ,
}
{
properties:
{
Description: Describes Machine Extension Update Properties. ,
Required: False ,
}
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 ,
}
string ,
}

⚐ Response (202)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine where the extension should be deleted. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
api-version:
{
Description: 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)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions/{extensionName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine containing the extension. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
api-version:
{
Description: 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 ,
}
string ,
}
MachineExtensions_List (removed)
Description :  The operation to get all extensions of a non-Azure machine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/extensions
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
name:
{
Description: The name of the machine containing the extension. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: 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 ,
}
string ,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of machine extensions. Call ListNext() with this to fetch the next page of extensions. ,
Required: False ,
}
string ,
}
Operations_List (removed)
Description :  Gets a list of hybrid compute operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.HybridCompute/operations
{
api-version:
{
Description: 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 ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: True ,
}
{
code:
{
Description: The error's code. ,
Required: True ,
}
string ,
message:
{
Description: A human readable error message. ,
Required: True ,
}
string ,
target:
{
Description: Indicates which property in the request is responsible for the error. ,
Required: False ,
}
string ,
details:
{
Description: Additional error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
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 ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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. ,
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 ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
}
,
]
,
}
,
}
,
]
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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. ,
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 ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
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. ,
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 ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
}
,
]
,
}
,
}
,
}

⚐ 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 ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
}
,
]
,
}
,
}

⚐ 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 ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
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. ,
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 ,
}
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 ,
privateEndpointConnections:
{
Description: List of private endpoint connections. ,
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 ,
}
,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
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. ,
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 ,
]
,
}
,
}
,
]
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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. ,
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 ,
]
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
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. ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
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. ,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
}

⚐ 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 ,
}
[
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 ,
}
,
]
,
}
,
}
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. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
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. ,
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 ,
}
,
}
,
]
,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
PrivateLinkScopedResources_Get (removed)
Description :  Gets a scoped resource in a private link scope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/scopedResources/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
name:
{
Description: The name of the scoped resource object. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
linkedResourceId:
{
Description: The resource id of the scoped Azure monitor resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: State of the private endpoint connection. ,
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 ,
}
,
]
,
}
,
}
PrivateLinkScopedResources_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}/scopedResources/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
name:
{
Description: The name of the scoped resource object. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
linkedResourceId:
{
Description: The resource id of the scoped Azure monitor resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
linkedResourceId:
{
Description: The resource id of the scoped Azure monitor resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: State of the private endpoint connection. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
linkedResourceId:
{
Description: The resource id of the scoped Azure monitor resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: State of the private endpoint connection. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
PrivateLinkScopedResources_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}/scopedResources/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
name:
{
Description: The name of the scoped resource object. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}
PrivateLinkScopedResources_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}/scopedResources
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
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 ,
}
{
linkedResourceId:
{
Description: The resource id of the scoped Azure monitor resource. ,
Required: False ,
}
string ,
provisioningState:
{
Description: State of the private endpoint connection. ,
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 ,
}
[
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 ,
}
,
]
,
}
,
}