Microsoft.HybridConnectivity (stable:2024-12-01)

2025/02/14 • 19 new, 14 updated, 19 deleted methods

SolutionConfigurations_List (new)
Description :  List SolutionConfiguration resources by parent
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SolutionConfiguration items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
solutionType:
{
Description: The type of the solution ,
Required: True ,
}
string ,
solutionSettings:
{
Description: Solution settings ,
Required: False ,
}
object ,
status:
{
Description: The status of solution configurations ,
Enum:
{
New: New status ,
InProgress: InProgress status ,
Completed: Canceled status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The detailed message of status details ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: The last time resources were inventoried ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
SolutionConfigurations_Get (new)
Description :  Get a SolutionConfiguration
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
solutionConfiguration:
{
Description: Represent Solution Configuration Resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
solutionType:
{
Description: The type of the solution ,
Required: True ,
}
string ,
solutionSettings:
{
Description: Solution settings ,
Required: False ,
}
object ,
status:
{
Description: The status of solution configurations ,
Enum:
{
New: New status ,
InProgress: InProgress status ,
Completed: Canceled status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The detailed message of status details ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: The last time resources were inventoried ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
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 ,
}
,
]
,
}
,
}
SolutionConfigurations_CreateOrUpdate (new)
Description :  Create a SolutionConfiguration
Reference :  Link ¶

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
solutionConfiguration:
{
Description: Represent Solution Configuration Resource. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
solutionType:
{
Description: The type of the solution ,
Required: True ,
}
string ,
solutionSettings:
{
Description: Solution settings ,
Required: False ,
}
object ,
status:
{
Description: The status of solution configurations ,
Enum:
{
New: New status ,
InProgress: InProgress status ,
Completed: Canceled status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The detailed message of status details ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: The last time resources were inventoried ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
solutionType:
{
Description: The type of the solution ,
Required: True ,
}
string ,
solutionSettings:
{
Description: Solution settings ,
Required: False ,
}
object ,
status:
{
Description: The status of solution configurations ,
Enum:
{
New: New status ,
InProgress: InProgress status ,
Completed: Canceled status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The detailed message of status details ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: The last time resources were inventoried ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
solutionType:
{
Description: The type of the solution ,
Required: True ,
}
string ,
solutionSettings:
{
Description: Solution settings ,
Required: False ,
}
object ,
status:
{
Description: The status of solution configurations ,
Enum:
{
New: New status ,
InProgress: InProgress status ,
Completed: Canceled status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The detailed message of status details ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: The last time resources were inventoried ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
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 ,
}
,
]
,
}
,
}
SolutionConfigurations_Update (new)
Description :  Update a SolutionConfiguration
Reference :  Link ¶

⚼ Request

PATCH:  /{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
solutionConfiguration:
{
Description: Represent Solution Configuration Resource. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionType:
{
Description: The type of the solution ,
Required: False ,
}
string ,
solutionSettings:
{
Description: Solution settings ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
solutionType:
{
Description: The type of the solution ,
Required: True ,
}
string ,
solutionSettings:
{
Description: Solution settings ,
Required: False ,
}
object ,
status:
{
Description: The status of solution configurations ,
Enum:
{
New: New status ,
InProgress: InProgress status ,
Completed: Canceled status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The detailed message of status details ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: The last time resources were inventoried ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
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 ,
}
,
]
,
}
,
}
SolutionConfigurations_Delete (new)
Description :  Delete a SolutionConfiguration
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
solutionConfiguration:
{
Description: Represent Solution Configuration Resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
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 ,
}
,
]
,
}
,
}
Inventory_ListBySolutionConfiguration (new)
Description :  List InventoryResource resources by SolutionConfiguration
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}/inventory
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
solutionConfiguration:
{
Description: Represent Solution Configuration Resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The InventoryResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
cloudNativeType:
{
Description: Gets or sets the cloud native resource type. ,
Enum:
{
ec2: ec2 enum. ,
}
,
Required: False ,
}
enum ,
cloudNativeResourceId:
{
Description: Gets or sets the cloud native resource name. ,
Required: False ,
}
string ,
azureResourceId:
{
Description: Gets or sets the mapped azure resource id. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the inventory. ,
Enum:
{
New: New status ,
InProgress: InProgress status ,
Completed: Canceled status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gets or sets the status details. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
Inventory_Get (new)
Description :  Get a InventoryResource
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}/inventory/{inventoryId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
solutionConfiguration:
{
Description: Represent Solution Configuration Resource. ,
Required: True ,
}
string ,
inventoryId:
{
Description: Inventory resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
cloudNativeType:
{
Description: Gets or sets the cloud native resource type. ,
Enum:
{
ec2: ec2 enum. ,
}
,
Required: False ,
}
enum ,
cloudNativeResourceId:
{
Description: Gets or sets the cloud native resource name. ,
Required: False ,
}
string ,
azureResourceId:
{
Description: Gets or sets the mapped azure resource id. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the inventory. ,
Enum:
{
New: New status ,
InProgress: InProgress status ,
Completed: Canceled status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gets or sets the status details. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
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 ,
}
,
]
,
}
,
}
SolutionConfigurations_SyncNow (new)
Description :  Trigger immediate sync with source cloud
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}/syncNow
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
solutionConfiguration:
{
Description: Represent Solution Configuration Resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the async operation. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully qualified ID of the resource against which the original async operation was started. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: True ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Required: False ,
}
number ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
operations:
{
Description: The operations list. ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified ID for the async operation. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully qualified ID of the resource against which the original async operation was started. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: True ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Required: False ,
}
number ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
operations:
{
Description: The operations list. ,
Required: False ,
}
[
string ,
]
,
error:
{
Description: If present, details of the operation error. ,
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 ,
}
,
]
,
}
,
}
,
]
,
error:
{
Description: If present, details of the operation error. ,
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 ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
GenerateAwsTemplate_Post (new)
Description :  Retrieve AWS Cloud Formation template
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridConnectivity/generateAwsTemplate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
generateAwsTemplateRequest:
{
Description: ConnectorId and SolutionTypes and their properties to Generate AWS CFT Template. ,
Required: True ,
}
{
connectorId:
{
Description: The name of public cloud connector ,
Required: True ,
}
string ,
solutionTypes:
{
Description: The list of solution types and their settings ,
Required: False ,
}
[
{
solutionType:
{
Description: The type of the solution ,
Required: True ,
}
string ,
solutionSettings:
{
Description: Solution settings ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ 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 ,
}
,
]
,
}
,
}
PublicCloudConnectors_ListBySubscription (new)
Description :  List PublicCloudConnector resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridConnectivity/publicCloudConnectors
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PublicCloudConnector items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
awsCloudProfile:
{
Description: Cloud profile for AWS. ,
Required: True ,
}
{
accountId:
{
Description: Account id for the AWS account. ,
Required: True ,
}
string ,
excludedAccounts:
{
Description: List of AWS accounts which need to be excluded. ,
Required: False ,
}
[
string ,
]
,
isOrganizationalAccount:
{
Description: Boolean value that indicates whether the account is organizational or not. True represents organization account, whereas false represents a single account. ,
Required: False ,
}
boolean ,
}
,
hostType:
{
Description: Host cloud the public cloud connector. ,
Enum:
{
AWS: AWS state ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
connectorPrimaryIdentifier:
{
Description: Connector primary identifier. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
SolutionTypes_ListBySubscription (new)
Description :  List SolutionTypeResource resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridConnectivity/solutionTypes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SolutionTypeResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionType:
{
Description: The name of the solution type. ,
Required: False ,
}
string ,
description:
{
Description: Short description of solution type. ,
Required: False ,
}
string ,
supportedAzureRegions:
{
Description: The locations this solution is supported in. ,
Required: False ,
}
[
string ,
]
,
solutionSettings:
{
Description: Array of solution settings and its description. ,
Required: False ,
}
[
{
name:
{
Description: The name of the solution setting property. ,
Required: True ,
}
string ,
displayName:
{
Description: The UI friendly name of the solution setting property. ,
Required: True ,
}
string ,
type:
{
Description: Type of the solution setting property, represented as a string. ,
Required: True ,
}
string ,
description:
{
Description: Description of solution setting property. ,
Required: True ,
}
string ,
allowedValues:
{
Description: Array of allowed values for this solution settings property. ,
Required: True ,
}
[
string ,
]
,
defaultValue:
{
Description: Default value for this solution settings property. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
PublicCloudConnectors_ListByResourceGroup (new)
Description :  List PublicCloudConnector resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/publicCloudConnectors
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PublicCloudConnector items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
awsCloudProfile:
{
Description: Cloud profile for AWS. ,
Required: True ,
}
{
accountId:
{
Description: Account id for the AWS account. ,
Required: True ,
}
string ,
excludedAccounts:
{
Description: List of AWS accounts which need to be excluded. ,
Required: False ,
}
[
string ,
]
,
isOrganizationalAccount:
{
Description: Boolean value that indicates whether the account is organizational or not. True represents organization account, whereas false represents a single account. ,
Required: False ,
}
boolean ,
}
,
hostType:
{
Description: Host cloud the public cloud connector. ,
Enum:
{
AWS: AWS state ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
connectorPrimaryIdentifier:
{
Description: Connector primary identifier. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
PublicCloudConnectors_Get (new)
Description :  Get a PublicCloudConnector
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{publicCloudConnector}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
publicCloudConnector:
{
Description: Represent public cloud connectors resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
awsCloudProfile:
{
Description: Cloud profile for AWS. ,
Required: True ,
}
{
accountId:
{
Description: Account id for the AWS account. ,
Required: True ,
}
string ,
excludedAccounts:
{
Description: List of AWS accounts which need to be excluded. ,
Required: False ,
}
[
string ,
]
,
isOrganizationalAccount:
{
Description: Boolean value that indicates whether the account is organizational or not. True represents organization account, whereas false represents a single account. ,
Required: False ,
}
boolean ,
}
,
hostType:
{
Description: Host cloud the public cloud connector. ,
Enum:
{
AWS: AWS state ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
connectorPrimaryIdentifier:
{
Description: Connector primary identifier. ,
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 ,
}
,
]
,
}
,
}
PublicCloudConnectors_CreateOrUpdate (new)
Description :  Create a PublicCloudConnector
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{publicCloudConnector}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
publicCloudConnector:
{
Description: Represent public cloud connectors resource. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
awsCloudProfile:
{
Description: Cloud profile for AWS. ,
Required: True ,
}
{
accountId:
{
Description: Account id for the AWS account. ,
Required: True ,
}
string ,
excludedAccounts:
{
Description: List of AWS accounts which need to be excluded. ,
Required: False ,
}
[
string ,
]
,
isOrganizationalAccount:
{
Description: Boolean value that indicates whether the account is organizational or not. True represents organization account, whereas false represents a single account. ,
Required: False ,
}
boolean ,
}
,
hostType:
{
Description: Host cloud the public cloud connector. ,
Enum:
{
AWS: AWS state ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
connectorPrimaryIdentifier:
{
Description: Connector primary identifier. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
awsCloudProfile:
{
Description: Cloud profile for AWS. ,
Required: True ,
}
{
accountId:
{
Description: Account id for the AWS account. ,
Required: True ,
}
string ,
excludedAccounts:
{
Description: List of AWS accounts which need to be excluded. ,
Required: False ,
}
[
string ,
]
,
isOrganizationalAccount:
{
Description: Boolean value that indicates whether the account is organizational or not. True represents organization account, whereas false represents a single account. ,
Required: False ,
}
boolean ,
}
,
hostType:
{
Description: Host cloud the public cloud connector. ,
Enum:
{
AWS: AWS state ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
connectorPrimaryIdentifier:
{
Description: Connector primary identifier. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Public Cloud Connector ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
awsCloudProfile:
{
Description: Cloud profile for AWS. ,
Required: True ,
}
{
accountId:
{
Description: Account id for the AWS account. ,
Required: True ,
}
string ,
excludedAccounts:
{
Description: List of AWS accounts which need to be excluded. ,
Required: False ,
}
[
string ,
]
,
isOrganizationalAccount:
{
Description: Boolean value that indicates whether the account is organizational or not. True represents organization account, whereas false represents a single account. ,
Required: False ,
}
boolean ,
}
,
hostType:
{
Description: Host cloud the public cloud connector. ,
Enum:
{
AWS: AWS state ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
connectorPrimaryIdentifier:
{
Description: Connector primary identifier. ,
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 ,
}
,
]
,
}
,
}
PublicCloudConnectors_Update (new)
Description :  Update a PublicCloudConnector
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{publicCloudConnector}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
publicCloudConnector:
{
Description: Represent public cloud connectors resource. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
awsCloudProfile:
{
Description: Cloud profile for AWS. ,
Required: False ,
}
{
excludedAccounts:
{
Description: List of AWS accounts which need to be excluded. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
awsCloudProfile:
{
Description: Cloud profile for AWS. ,
Required: True ,
}
{
accountId:
{
Description: Account id for the AWS account. ,
Required: True ,
}
string ,
excludedAccounts:
{
Description: List of AWS accounts which need to be excluded. ,
Required: False ,
}
[
string ,
]
,
isOrganizationalAccount:
{
Description: Boolean value that indicates whether the account is organizational or not. True represents organization account, whereas false represents a single account. ,
Required: False ,
}
boolean ,
}
,
hostType:
{
Description: Host cloud the public cloud connector. ,
Enum:
{
AWS: AWS state ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
connectorPrimaryIdentifier:
{
Description: Connector primary identifier. ,
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 ,
}
,
]
,
}
,
}
PublicCloudConnectors_Delete (new)
Description :  Delete a PublicCloudConnector
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{publicCloudConnector}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
publicCloudConnector:
{
Description: Represent public cloud connectors resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
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 ,
}
,
]
,
}
,
}
PublicCloudConnectors_TestPermissions (new)
Description :  A long-running resource action.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{publicCloudConnector}/testPermissions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
publicCloudConnector:
{
Description: Represent public cloud connectors resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the async operation. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully qualified ID of the resource against which the original async operation was started. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: True ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Required: False ,
}
number ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
operations:
{
Description: The operations list. ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified ID for the async operation. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully qualified ID of the resource against which the original async operation was started. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: True ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Required: False ,
}
number ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
operations:
{
Description: The operations list. ,
Required: False ,
}
[
string ,
]
,
error:
{
Description: If present, details of the operation error. ,
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 ,
}
,
]
,
}
,
}
,
]
,
error:
{
Description: If present, details of the operation error. ,
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 ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
SolutionTypes_ListByResourceGroup (new)
Description :  List SolutionTypeResource resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/solutionTypes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SolutionTypeResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionType:
{
Description: The name of the solution type. ,
Required: False ,
}
string ,
description:
{
Description: Short description of solution type. ,
Required: False ,
}
string ,
supportedAzureRegions:
{
Description: The locations this solution is supported in. ,
Required: False ,
}
[
string ,
]
,
solutionSettings:
{
Description: Array of solution settings and its description. ,
Required: False ,
}
[
{
name:
{
Description: The name of the solution setting property. ,
Required: True ,
}
string ,
displayName:
{
Description: The UI friendly name of the solution setting property. ,
Required: True ,
}
string ,
type:
{
Description: Type of the solution setting property, represented as a string. ,
Required: True ,
}
string ,
description:
{
Description: Description of solution setting property. ,
Required: True ,
}
string ,
allowedValues:
{
Description: Array of allowed values for this solution settings property. ,
Required: True ,
}
[
string ,
]
,
defaultValue:
{
Description: Default value for this solution settings property. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
SolutionTypes_Get (new)
Description :  Get a SolutionTypeResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/solutionTypes/{solutionType}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
solutionType:
{
Description: Solution Type resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionType:
{
Description: The name of the solution type. ,
Required: False ,
}
string ,
description:
{
Description: Short description of solution type. ,
Required: False ,
}
string ,
supportedAzureRegions:
{
Description: The locations this solution is supported in. ,
Required: False ,
}
[
string ,
]
,
solutionSettings:
{
Description: Array of solution settings and its description. ,
Required: False ,
}
[
{
name:
{
Description: The name of the solution setting property. ,
Required: True ,
}
string ,
displayName:
{
Description: The UI friendly name of the solution setting property. ,
Required: True ,
}
string ,
type:
{
Description: Type of the solution setting property, represented as a string. ,
Required: True ,
}
string ,
description:
{
Description: Description of solution setting property. ,
Required: True ,
}
string ,
allowedValues:
{
Description: Array of allowed values for this solution settings property. ,
Required: True ,
}
[
string ,
]
,
defaultValue:
{
Description: Default value for this solution settings property. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
Endpoints_List (updated)
Description :  List of endpoints to the target resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Endpoints_List",
  "$parameters": [
    {
      "#name": "resourceUri",
      "Description": {
        "new": "The fully qualified Azure Resource manager identifier of the resource.",
        "old": "The fully qualified Azure Resource manager identifier of the resource to be connected."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_8a0e26758967430ba807c68a8497befb": {
                "#name": "systemData",
                "Description": "System data of endpoint resource",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdAt",
                    "Description": "The timestamp of resource creation (UTC).",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedAt",
                    "Description": "The timestamp of resource last modification (UTC)",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of endpoint. ,
Required: True ,
}
[
{
properties:
{
Description: The endpoint properties. ,
Required: False ,
}
{
type:
{
Description: The type of endpoint. ,
Enum:
{
default: No description available. ,
custom: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource Id of the connectivity endpoint (optional). ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The resource provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of endpoints list. ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
Endpoints_Get (updated)
Description :  Gets the endpoint to the resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Endpoints_Get",
  "$parameters": [
    {
      "#name": "resourceUri",
      "Description": {
        "new": "The fully qualified Azure Resource manager identifier of the resource.",
        "old": "The fully qualified Azure Resource manager identifier of the resource to be connected."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_21f22215c98d44188b4056d9303d433e": {
          "#name": "systemData",
          "Description": "System data of endpoint resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
endpointName:
{
Description: The endpoint name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The endpoint properties. ,
Required: False ,
}
{
type:
{
Description: The type of endpoint. ,
Enum:
{
default: No description available. ,
custom: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource Id of the connectivity endpoint (optional). ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The resource provisioning state. ,
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 ,
}
,
]
,
}
,
}
Endpoints_CreateOrUpdate (updated)
Description :  Create or update the endpoint to the target resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Endpoints_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "resourceUri",
      "Description": {
        "new": "The fully qualified Azure Resource manager identifier of the resource.",
        "old": "The fully qualified Azure Resource manager identifier of the resource to be connected."
      }
    },
    {
      "EndpointResource": {
        "$properties": {
          "@removed_1a90bab59578424cb5f1785bac6df123": {
            "#name": "systemData",
            "Description": "System data of endpoint resource",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_d5671d8a70374d1e81e50e5f74e10c78": {
          "#name": "systemData",
          "Description": "System data of endpoint resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
endpointName:
{
Description: The endpoint name. ,
Required: True ,
}
string ,
EndpointResource:
{
Description: Endpoint details ,
Required: True ,
}
{
properties:
{
Description: The endpoint properties. ,
Required: False ,
}
{
type:
{
Description: The type of endpoint. ,
Enum:
{
default: No description available. ,
custom: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource Id of the connectivity endpoint (optional). ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The resource provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The endpoint properties. ,
Required: False ,
}
{
type:
{
Description: The type of endpoint. ,
Enum:
{
default: No description available. ,
custom: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource Id of the connectivity endpoint (optional). ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The resource provisioning state. ,
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 ,
}
,
]
,
}
,
}
Endpoints_Update (updated)
Description :  Update the endpoint to the target resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Endpoints_Update",
  "$parameters": [
    {
      "#name": "resourceUri",
      "Description": {
        "new": "The fully qualified Azure Resource manager identifier of the resource.",
        "old": "The fully qualified Azure Resource manager identifier of the resource to be connected."
      }
    },
    {
      "EndpointResource": {
        "$properties": {
          "@removed_cd4809b0f5fc4e58824b22fc954e7086": {
            "#name": "systemData",
            "Description": "System data of endpoint resource",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_3964e84683d34db5844d3079a5d84ceb": {
          "#name": "systemData",
          "Description": "System data of endpoint resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

PATCH:  /{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
endpointName:
{
Description: The endpoint name. ,
Required: True ,
}
string ,
EndpointResource:
{
Description: Endpoint details ,
Required: True ,
}
{
properties:
{
Description: The endpoint properties. ,
Required: False ,
}
{
type:
{
Description: The type of endpoint. ,
Enum:
{
default: No description available. ,
custom: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource Id of the connectivity endpoint (optional). ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The resource provisioning state. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The endpoint properties. ,
Required: False ,
}
{
type:
{
Description: The type of endpoint. ,
Enum:
{
default: No description available. ,
custom: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource Id of the connectivity endpoint (optional). ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: The resource provisioning state. ,
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 ,
}
,
]
,
}
,
}
Endpoints_Delete (updated)
Description :  Deletes the endpoint access to the target resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Endpoints_Delete",
  "$parameters": [
    {
      "#name": "resourceUri",
      "Description": {
        "new": "The fully qualified Azure Resource manager identifier of the resource.",
        "old": "The fully qualified Azure Resource manager identifier of the resource to be connected."
      }
    }
  ]
}

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
endpointName:
{
Description: The endpoint name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
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 ,
}
,
]
,
}
,
}
Endpoints_ListCredentials (updated)
Description :  Gets the endpoint access credentials to the resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Endpoints_ListCredentials",
  "$parameters": [
    {
      "#name": "resourceUri",
      "Description": {
        "new": "The fully qualified Azure Resource manager identifier of the resource.",
        "old": "The fully qualified Azure Resource manager identifier of the resource to be connected."
      }
    },
    {
      "ListCredentialsRequest": {
        "$properties": [
          {
            "#name": "serviceName",
            "Description": {
              "new": "The name of the service. If not provided, the request will by pass the generation of service configuration token",
              "old": "The name of the service. If not provided, the request will by pass the generation of service configuration token "
            }
          }
        ]
      }
    }
  ]
}

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/listCredentials
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
endpointName:
{
Description: The endpoint name. ,
Required: True ,
}
string ,
expiresin:
{
Description: The is how long the endpoint access token is valid (in seconds). ,
Format: int64 ,
Required: False ,
}
integer ,
ListCredentialsRequest:
{
Description: Object of type ListCredentialsRequest ,
Required: False ,
}
{
serviceName:
{
Description: The name of the service. If not provided, the request will by pass the generation of service configuration token ,
Enum:
{
SSH: No description available. ,
WAC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
relay:
{
Description: Azure relay hybrid connection access properties ,
Required: False ,
}
{
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
namespaceNameSuffix:
{
Description: The suffix domain name of relay namespace. ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: Azure Relay hybrid connection name for the resource. ,
Required: True ,
}
string ,
accessKey:
{
Description: Access key for hybrid connection. ,
Required: False ,
}
string ,
expiresOn:
{
Description: The expiration of access key in unix time. ,
Format: int64 ,
Required: False ,
}
integer ,
serviceConfigurationToken:
{
Description: The token to access the enabled service. ,
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 ,
}
,
]
,
}
,
}
Endpoints_ListIngressGatewayCredentials (updated)
Description :  Gets the ingress gateway endpoint credentials
Reference :  Link ¶

⚶ Changes

{
  "#id": "Endpoints_ListIngressGatewayCredentials",
  "$parameters": [
    {
      "#name": "resourceUri",
      "Description": {
        "new": "The fully qualified Azure Resource manager identifier of the resource.",
        "old": "The fully qualified Azure Resource manager identifier of the resource to be connected."
      }
    },
    {
      "ListIngressGatewayCredentialsRequest": {
        "$properties": [
          {
            "#name": "serviceName",
            "Description": {
              "new": "The name of the service. If not provided, the request will by pass the generation of service configuration token.",
              "old": "The name of the service."
            }
          }
        ]
      }
    }
  ]
}

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/listIngressGatewayCredentials
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
endpointName:
{
Description: The endpoint name. ,
Required: True ,
}
string ,
expiresin:
{
Description: The is how long the endpoint access token is valid (in seconds). ,
Format: int64 ,
Required: False ,
}
integer ,
ListIngressGatewayCredentialsRequest:
{
Description: Object of type ListIngressGatewayCredentialsRequest ,
Required: False ,
}
{
serviceName:
{
Description: The name of the service. If not provided, the request will by pass the generation of service configuration token. ,
Enum:
{
SSH: No description available. ,
WAC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
relay:
{
Description: Azure relay hybrid connection access properties ,
Required: False ,
}
{
namespaceName:
{
Description: The namespace name. ,
Required: True ,
}
string ,
namespaceNameSuffix:
{
Description: The suffix domain name of relay namespace. ,
Required: True ,
}
string ,
hybridConnectionName:
{
Description: Azure Relay hybrid connection name for the resource. ,
Required: True ,
}
string ,
accessKey:
{
Description: Access key for hybrid connection. ,
Required: False ,
}
string ,
expiresOn:
{
Description: The expiration of access key in unix time. ,
Format: int64 ,
Required: False ,
}
integer ,
serviceConfigurationToken:
{
Description: The token to access the enabled service. ,
Required: False ,
}
string ,
}
,
ingress:
{
Description: Ingress gateway profile ,
Required: False ,
}
{
hostname:
{
Description: The ingress hostname. ,
Required: True ,
}
string ,
aadProfile:
{
Description: The AAD Profile ,
Required: True ,
}
{
serverId:
{
Description: The arc ingress gateway server app id. ,
Required: True ,
}
string ,
tenantId:
{
Description: The target resource home tenant id. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
Endpoints_ListManagedProxyDetails (updated)
Description :  Fetches the managed proxy details
Reference :  Link ¶

⚶ Changes

{
  "#id": "Endpoints_ListManagedProxyDetails",
  "$parameters": [
    {
      "#name": "resourceUri",
      "Description": {
        "new": "The fully qualified Azure Resource manager identifier of the resource.",
        "old": "The fully qualified Azure Resource manager identifier of the resource to be connected."
      }
    }
  ]
}

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/listManagedProxyDetails
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
endpointName:
{
Description: The endpoint name. ,
Required: True ,
}
string ,
ManagedProxyRequest:
{
Description: Object of type ManagedProxyRequest ,
Required: True ,
}
{
service:
{
Description: The name of the service. ,
Required: True ,
}
string ,
hostname:
{
Description: The target host name. ,
Required: False ,
}
string ,
serviceName:
{
Description: The name of the service. It is an optional property, if not provided, service configuration tokens issue code would be by passed. ,
Enum:
{
SSH: No description available. ,
WAC: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
proxy:
{
Description: The short lived proxy name. ,
Required: True ,
}
string ,
expiresOn:
{
Description: The expiration time of short lived proxy name in unix epoch. ,
Format: int64 ,
Required: True ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
ServiceConfigurations_ListByEndpointResource (updated)
Description :  API to enumerate registered services in service configurations under a Endpoint Resource
Reference :  Link ¶

⚶ Changes

{
  "#id": "ServiceConfigurations_ListByEndpointResource",
  "$parameters": [
    {
      "#name": "resourceUri",
      "Description": {
        "new": "The fully qualified Azure Resource manager identifier of the resource.",
        "old": "The fully qualified Azure Resource manager identifier of the resource to be connected."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_37f4e38d3bde415ab6745d55d54c556d": {
                "#name": "systemData",
                "Description": "System data of endpoint resource",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdAt",
                    "Description": "The timestamp of resource creation (UTC).",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedAt",
                    "Description": "The timestamp of resource last modification (UTC)",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/serviceConfigurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
endpointName:
{
Description: The endpoint name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of service configuration ,
Required: True ,
}
[
{
properties:
{
Description: The service configuration properties. ,
Required: False ,
}
{
serviceName:
{
Description: Name of the service. ,
Enum:
{
SSH: No description available. ,
WAC: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource Id of the connectivity endpoint (optional). ,
Format: arm-id ,
Required: False ,
}
string ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to fetch the next page of connected cluster ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
ServiceConfigurations_Get (updated)
Description :  Gets the details about the service to the resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ServiceConfigurations_Get",
  "$parameters": [
    {
      "#name": "resourceUri",
      "Description": {
        "new": "The fully qualified Azure Resource manager identifier of the resource.",
        "old": "The fully qualified Azure Resource manager identifier of the resource to be connected."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_fb0144f7e32247a0a857e87e42801b01": {
          "#name": "systemData",
          "Description": "System data of endpoint resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/serviceConfigurations/{serviceConfigurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
endpointName:
{
Description: The endpoint name. ,
Required: True ,
}
string ,
serviceConfigurationName:
{
Description: The service name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The service configuration properties. ,
Required: False ,
}
{
serviceName:
{
Description: Name of the service. ,
Enum:
{
SSH: No description available. ,
WAC: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource Id of the connectivity endpoint (optional). ,
Format: arm-id ,
Required: False ,
}
string ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
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 ,
}
,
]
,
}
,
}
ServiceConfigurations_CreateOrupdate (updated)
Description :  Create or update a service in serviceConfiguration for the endpoint resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ServiceConfigurations_CreateOrupdate",
  "$parameters": [
    {
      "#name": "resourceUri",
      "Description": {
        "new": "The fully qualified Azure Resource manager identifier of the resource.",
        "old": "The fully qualified Azure Resource manager identifier of the resource to be connected."
      }
    },
    {
      "ServiceConfigurationResource": {
        "$properties": {
          "@removed_ac3ecbe6596a43b49992a9a08257664c": {
            "#name": "systemData",
            "Description": "System data of endpoint resource",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "createdAt",
                "Description": "The timestamp of resource creation (UTC).",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "lastModifiedAt",
                "Description": "The timestamp of resource last modification (UTC)",
                "Format": "date-time",
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_1123b39b38d94efa8284921aa5afbe51": {
          "#name": "systemData",
          "Description": "System data of endpoint resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_cb2e17abc7334a88ababd997d2b730d7": {
          "#name": "systemData",
          "Description": "System data of endpoint resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/serviceConfigurations/{serviceConfigurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
endpointName:
{
Description: The endpoint name. ,
Required: True ,
}
string ,
serviceConfigurationName:
{
Description: The service name. ,
Required: True ,
}
string ,
ServiceConfigurationResource:
{
Description: Service details ,
Required: True ,
}
{
properties:
{
Description: The service configuration properties. ,
Required: False ,
}
{
serviceName:
{
Description: Name of the service. ,
Enum:
{
SSH: No description available. ,
WAC: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource Id of the connectivity endpoint (optional). ,
Format: arm-id ,
Required: False ,
}
string ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The service configuration properties. ,
Required: False ,
}
{
serviceName:
{
Description: Name of the service. ,
Enum:
{
SSH: No description available. ,
WAC: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource Id of the connectivity endpoint (optional). ,
Format: arm-id ,
Required: False ,
}
string ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The service configuration properties. ,
Required: False ,
}
{
serviceName:
{
Description: Name of the service. ,
Enum:
{
SSH: No description available. ,
WAC: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource Id of the connectivity endpoint (optional). ,
Format: arm-id ,
Required: False ,
}
string ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
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 ,
}
,
]
,
}
,
}
ServiceConfigurations_Update (updated)
Description :  Update the service details in the service configurations of the target resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ServiceConfigurations_Update",
  "$parameters": [
    {
      "#name": "resourceUri",
      "Description": {
        "new": "The fully qualified Azure Resource manager identifier of the resource.",
        "old": "The fully qualified Azure Resource manager identifier of the resource to be connected."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@removed_26e154801319484594d34f52eecbac3e": {
          "#name": "systemData",
          "Description": "System data of endpoint resource",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

PATCH:  /{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/serviceConfigurations/{serviceConfigurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
endpointName:
{
Description: The endpoint name. ,
Required: True ,
}
string ,
serviceConfigurationName:
{
Description: The service name. ,
Required: True ,
}
string ,
ServiceConfigurationResource:
{
Description: Service details ,
Required: True ,
}
{
properties:
{
Description: The service configuration properties. ,
Required: False ,
}
{
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The service configuration properties. ,
Required: False ,
}
{
serviceName:
{
Description: Name of the service. ,
Enum:
{
SSH: No description available. ,
WAC: No description available. ,
}
,
Required: True ,
}
enum ,
resourceId:
{
Description: The resource Id of the connectivity endpoint (optional). ,
Format: arm-id ,
Required: False ,
}
string ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
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 ,
}
,
]
,
}
,
}
ServiceConfigurations_Delete (updated)
Description :  Deletes the service details to the target resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ServiceConfigurations_Delete",
  "$parameters": [
    {
      "#name": "resourceUri",
      "Description": {
        "new": "The fully qualified Azure Resource manager identifier of the resource.",
        "old": "The fully qualified Azure Resource manager identifier of the resource to be connected."
      }
    }
  ]
}

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/serviceConfigurations/{serviceConfigurationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
endpointName:
{
Description: The endpoint name. ,
Required: True ,
}
string ,
serviceConfigurationName:
{
Description: The service name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (updated)
Description :  List the operations for the provider
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "Description": {
    "new": "List the operations for the provider",
    "old": "Lists the available Hybrid Connectivity REST API operations."
  }
}

⚼ Request

GET:  /providers/Microsoft.HybridConnectivity/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
SolutionConfigurations_List (removed)
Description :  List SolutionConfiguration resources by parent
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SolutionConfiguration items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
solutionType:
{
Description: The type of the solution ,
Required: True ,
}
string ,
solutionSettings:
{
Description: Solution settings ,
Required: False ,
}
object ,
status:
{
Description: The status of solution configurations ,
Enum:
{
New: New status ,
InProgress: InProgress status ,
Completed: Canceled status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The detailed message of status details ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: The last time resources were inventoried ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
SolutionConfigurations_Get (removed)
Description :  Get a SolutionConfiguration
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
solutionConfiguration:
{
Description: Represent Solution Configuration Resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
solutionType:
{
Description: The type of the solution ,
Required: True ,
}
string ,
solutionSettings:
{
Description: Solution settings ,
Required: False ,
}
object ,
status:
{
Description: The status of solution configurations ,
Enum:
{
New: New status ,
InProgress: InProgress status ,
Completed: Canceled status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The detailed message of status details ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: The last time resources were inventoried ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
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 ,
}
,
]
,
}
,
}
SolutionConfigurations_CreateOrUpdate (removed)
Description :  Create a SolutionConfiguration
Reference :  Link ¶

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
solutionConfiguration:
{
Description: Represent Solution Configuration Resource. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
solutionType:
{
Description: The type of the solution ,
Required: True ,
}
string ,
solutionSettings:
{
Description: Solution settings ,
Required: False ,
}
object ,
status:
{
Description: The status of solution configurations ,
Enum:
{
New: New status ,
InProgress: InProgress status ,
Completed: Canceled status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The detailed message of status details ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: The last time resources were inventoried ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
solutionType:
{
Description: The type of the solution ,
Required: True ,
}
string ,
solutionSettings:
{
Description: Solution settings ,
Required: False ,
}
object ,
status:
{
Description: The status of solution configurations ,
Enum:
{
New: New status ,
InProgress: InProgress status ,
Completed: Canceled status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The detailed message of status details ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: The last time resources were inventoried ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
solutionType:
{
Description: The type of the solution ,
Required: True ,
}
string ,
solutionSettings:
{
Description: Solution settings ,
Required: False ,
}
object ,
status:
{
Description: The status of solution configurations ,
Enum:
{
New: New status ,
InProgress: InProgress status ,
Completed: Canceled status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The detailed message of status details ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: The last time resources were inventoried ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
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 ,
}
,
]
,
}
,
}
SolutionConfigurations_Update (removed)
Description :  Update a SolutionConfiguration
Reference :  Link ¶

⚼ Request

PATCH:  /{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
solutionConfiguration:
{
Description: Represent Solution Configuration Resource. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionType:
{
Description: The type of the solution ,
Required: False ,
}
string ,
solutionSettings:
{
Description: Solution settings ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
solutionType:
{
Description: The type of the solution ,
Required: True ,
}
string ,
solutionSettings:
{
Description: Solution settings ,
Required: False ,
}
object ,
status:
{
Description: The status of solution configurations ,
Enum:
{
New: New status ,
InProgress: InProgress status ,
Completed: Canceled status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: The detailed message of status details ,
Required: False ,
}
string ,
lastSyncTime:
{
Description: The last time resources were inventoried ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
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 ,
}
,
]
,
}
,
}
SolutionConfigurations_Delete (removed)
Description :  Delete a SolutionConfiguration
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
solutionConfiguration:
{
Description: Represent Solution Configuration Resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
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 ,
}
,
]
,
}
,
}
Inventory_ListBySolutionConfiguration (removed)
Description :  List InventoryResource resources by SolutionConfiguration
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}/inventory
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
solutionConfiguration:
{
Description: Represent Solution Configuration Resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The InventoryResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
cloudNativeType:
{
Description: Gets or sets the cloud native resource type. ,
Enum:
{
ec2: ec2 enum. ,
}
,
Required: False ,
}
enum ,
cloudNativeResourceId:
{
Description: Gets or sets the cloud native resource name. ,
Required: False ,
}
string ,
azureResourceId:
{
Description: Gets or sets the mapped azure resource id. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the inventory. ,
Enum:
{
New: New status ,
InProgress: InProgress status ,
Completed: Canceled status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gets or sets the status details. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
Inventory_Get (removed)
Description :  Get a InventoryResource
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}/inventory/{inventoryId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
solutionConfiguration:
{
Description: Represent Solution Configuration Resource. ,
Required: True ,
}
string ,
inventoryId:
{
Description: Inventory resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
cloudNativeType:
{
Description: Gets or sets the cloud native resource type. ,
Enum:
{
ec2: ec2 enum. ,
}
,
Required: False ,
}
enum ,
cloudNativeResourceId:
{
Description: Gets or sets the cloud native resource name. ,
Required: False ,
}
string ,
azureResourceId:
{
Description: Gets or sets the mapped azure resource id. ,
Required: False ,
}
string ,
status:
{
Description: Gets or sets the status of the inventory. ,
Enum:
{
New: New status ,
InProgress: InProgress status ,
Completed: Canceled status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gets or sets the status details. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
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 ,
}
,
]
,
}
,
}
SolutionConfigurations_SyncNow (removed)
Description :  Trigger immediate sync with source cloud
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}/syncNow
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
solutionConfiguration:
{
Description: Represent Solution Configuration Resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the async operation. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully qualified ID of the resource against which the original async operation was started. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: True ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Required: False ,
}
number ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
operations:
{
Description: The operations list. ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified ID for the async operation. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully qualified ID of the resource against which the original async operation was started. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: True ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Required: False ,
}
number ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
operations:
{
Description: The operations list. ,
Required: False ,
}
[
string ,
]
,
error:
{
Description: If present, details of the operation error. ,
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 ,
}
,
]
,
}
,
}
,
]
,
error:
{
Description: If present, details of the operation error. ,
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 ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
GenerateAwsTemplate_Post (removed)
Description :  Retrieve AWS Cloud Formation template
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridConnectivity/generateAwsTemplate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
generateAwsTemplateRequest:
{
Description: ConnectorId and SolutionTypes and their properties to Generate AWS CFT Template. ,
Required: True ,
}
{
connectorId:
{
Description: The name of public cloud connector ,
Required: True ,
}
string ,
solutionTypes:
{
Description: The list of solution types and their settings ,
Required: False ,
}
[
{
solutionType:
{
Description: The type of the solution ,
Required: True ,
}
string ,
solutionSettings:
{
Description: Solution settings ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ 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 ,
}
,
]
,
}
,
}
PublicCloudConnectors_ListBySubscription (removed)
Description :  List PublicCloudConnector resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridConnectivity/publicCloudConnectors
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PublicCloudConnector items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
awsCloudProfile:
{
Description: Cloud profile for AWS. ,
Required: True ,
}
{
accountId:
{
Description: Account id for the AWS account. ,
Required: True ,
}
string ,
excludedAccounts:
{
Description: List of AWS accounts which need to be excluded. ,
Required: False ,
}
[
string ,
]
,
isOrganizationalAccount:
{
Description: Boolean value that indicates whether the account is organizational or not. True represents organization account, whereas false represents a single account. ,
Required: False ,
}
boolean ,
}
,
hostType:
{
Description: Host cloud the public cloud connector. ,
Enum:
{
AWS: AWS state ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
connectorPrimaryIdentifier:
{
Description: Connector primary identifier. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
SolutionTypes_ListBySubscription (removed)
Description :  List SolutionTypeResource resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.HybridConnectivity/solutionTypes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SolutionTypeResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionType:
{
Description: The name of the solution type. ,
Required: False ,
}
string ,
description:
{
Description: Short description of solution type. ,
Required: False ,
}
string ,
supportedAzureRegions:
{
Description: The locations this solution is supported in. ,
Required: False ,
}
[
string ,
]
,
solutionSettings:
{
Description: Array of solution settings and its description. ,
Required: False ,
}
[
{
name:
{
Description: The name of the solution setting property. ,
Required: True ,
}
string ,
displayName:
{
Description: The UI friendly name of the solution setting property. ,
Required: True ,
}
string ,
type:
{
Description: Type of the solution setting property, represented as a string. ,
Required: True ,
}
string ,
description:
{
Description: Description of solution setting property. ,
Required: True ,
}
string ,
allowedValues:
{
Description: Array of allowed values for this solution settings property. ,
Required: True ,
}
[
string ,
]
,
defaultValue:
{
Description: Default value for this solution settings property. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
PublicCloudConnectors_ListByResourceGroup (removed)
Description :  List PublicCloudConnector resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/publicCloudConnectors
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PublicCloudConnector items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
awsCloudProfile:
{
Description: Cloud profile for AWS. ,
Required: True ,
}
{
accountId:
{
Description: Account id for the AWS account. ,
Required: True ,
}
string ,
excludedAccounts:
{
Description: List of AWS accounts which need to be excluded. ,
Required: False ,
}
[
string ,
]
,
isOrganizationalAccount:
{
Description: Boolean value that indicates whether the account is organizational or not. True represents organization account, whereas false represents a single account. ,
Required: False ,
}
boolean ,
}
,
hostType:
{
Description: Host cloud the public cloud connector. ,
Enum:
{
AWS: AWS state ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
connectorPrimaryIdentifier:
{
Description: Connector primary identifier. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
PublicCloudConnectors_Get (removed)
Description :  Get a PublicCloudConnector
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{publicCloudConnector}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
publicCloudConnector:
{
Description: Represent public cloud connectors resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
awsCloudProfile:
{
Description: Cloud profile for AWS. ,
Required: True ,
}
{
accountId:
{
Description: Account id for the AWS account. ,
Required: True ,
}
string ,
excludedAccounts:
{
Description: List of AWS accounts which need to be excluded. ,
Required: False ,
}
[
string ,
]
,
isOrganizationalAccount:
{
Description: Boolean value that indicates whether the account is organizational or not. True represents organization account, whereas false represents a single account. ,
Required: False ,
}
boolean ,
}
,
hostType:
{
Description: Host cloud the public cloud connector. ,
Enum:
{
AWS: AWS state ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
connectorPrimaryIdentifier:
{
Description: Connector primary identifier. ,
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 ,
}
,
]
,
}
,
}
PublicCloudConnectors_CreateOrUpdate (removed)
Description :  Create a PublicCloudConnector
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{publicCloudConnector}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
publicCloudConnector:
{
Description: Represent public cloud connectors resource. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
awsCloudProfile:
{
Description: Cloud profile for AWS. ,
Required: True ,
}
{
accountId:
{
Description: Account id for the AWS account. ,
Required: True ,
}
string ,
excludedAccounts:
{
Description: List of AWS accounts which need to be excluded. ,
Required: False ,
}
[
string ,
]
,
isOrganizationalAccount:
{
Description: Boolean value that indicates whether the account is organizational or not. True represents organization account, whereas false represents a single account. ,
Required: False ,
}
boolean ,
}
,
hostType:
{
Description: Host cloud the public cloud connector. ,
Enum:
{
AWS: AWS state ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
connectorPrimaryIdentifier:
{
Description: Connector primary identifier. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
awsCloudProfile:
{
Description: Cloud profile for AWS. ,
Required: True ,
}
{
accountId:
{
Description: Account id for the AWS account. ,
Required: True ,
}
string ,
excludedAccounts:
{
Description: List of AWS accounts which need to be excluded. ,
Required: False ,
}
[
string ,
]
,
isOrganizationalAccount:
{
Description: Boolean value that indicates whether the account is organizational or not. True represents organization account, whereas false represents a single account. ,
Required: False ,
}
boolean ,
}
,
hostType:
{
Description: Host cloud the public cloud connector. ,
Enum:
{
AWS: AWS state ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
connectorPrimaryIdentifier:
{
Description: Connector primary identifier. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Public Cloud Connector ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
awsCloudProfile:
{
Description: Cloud profile for AWS. ,
Required: True ,
}
{
accountId:
{
Description: Account id for the AWS account. ,
Required: True ,
}
string ,
excludedAccounts:
{
Description: List of AWS accounts which need to be excluded. ,
Required: False ,
}
[
string ,
]
,
isOrganizationalAccount:
{
Description: Boolean value that indicates whether the account is organizational or not. True represents organization account, whereas false represents a single account. ,
Required: False ,
}
boolean ,
}
,
hostType:
{
Description: Host cloud the public cloud connector. ,
Enum:
{
AWS: AWS state ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
connectorPrimaryIdentifier:
{
Description: Connector primary identifier. ,
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 ,
}
,
]
,
}
,
}
PublicCloudConnectors_Update (removed)
Description :  Update a PublicCloudConnector
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{publicCloudConnector}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
publicCloudConnector:
{
Description: Represent public cloud connectors resource. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
awsCloudProfile:
{
Description: Cloud profile for AWS. ,
Required: False ,
}
{
excludedAccounts:
{
Description: List of AWS accounts which need to be excluded. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
awsCloudProfile:
{
Description: Cloud profile for AWS. ,
Required: True ,
}
{
accountId:
{
Description: Account id for the AWS account. ,
Required: True ,
}
string ,
excludedAccounts:
{
Description: List of AWS accounts which need to be excluded. ,
Required: False ,
}
[
string ,
]
,
isOrganizationalAccount:
{
Description: Boolean value that indicates whether the account is organizational or not. True represents organization account, whereas false represents a single account. ,
Required: False ,
}
boolean ,
}
,
hostType:
{
Description: Host cloud the public cloud connector. ,
Enum:
{
AWS: AWS state ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
connectorPrimaryIdentifier:
{
Description: Connector primary identifier. ,
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 ,
}
,
]
,
}
,
}
PublicCloudConnectors_Delete (removed)
Description :  Delete a PublicCloudConnector
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{publicCloudConnector}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
publicCloudConnector:
{
Description: Represent public cloud connectors resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
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 ,
}
,
]
,
}
,
}
PublicCloudConnectors_TestPermissions (removed)
Description :  A long-running resource action.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/publicCloudConnectors/{publicCloudConnector}/testPermissions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
publicCloudConnector:
{
Description: Represent public cloud connectors resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the async operation. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully qualified ID of the resource against which the original async operation was started. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: True ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Required: False ,
}
number ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
operations:
{
Description: The operations list. ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified ID for the async operation. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully qualified ID of the resource against which the original async operation was started. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: True ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Required: False ,
}
number ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
operations:
{
Description: The operations list. ,
Required: False ,
}
[
string ,
]
,
error:
{
Description: If present, details of the operation error. ,
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 ,
}
,
]
,
}
,
}
,
]
,
error:
{
Description: If present, details of the operation error. ,
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 ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
SolutionTypes_ListByResourceGroup (removed)
Description :  List SolutionTypeResource resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/solutionTypes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SolutionTypeResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionType:
{
Description: The name of the solution type. ,
Required: False ,
}
string ,
description:
{
Description: Short description of solution type. ,
Required: False ,
}
string ,
supportedAzureRegions:
{
Description: The locations this solution is supported in. ,
Required: False ,
}
[
string ,
]
,
solutionSettings:
{
Description: Array of solution settings and its description. ,
Required: False ,
}
[
{
name:
{
Description: The name of the solution setting property. ,
Required: True ,
}
string ,
displayName:
{
Description: The UI friendly name of the solution setting property. ,
Required: True ,
}
string ,
type:
{
Description: Type of the solution setting property, represented as a string. ,
Required: True ,
}
string ,
description:
{
Description: Description of solution setting property. ,
Required: True ,
}
string ,
allowedValues:
{
Description: Array of allowed values for this solution settings property. ,
Required: True ,
}
[
string ,
]
,
defaultValue:
{
Description: Default value for this solution settings property. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
SolutionTypes_Get (removed)
Description :  Get a SolutionTypeResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridConnectivity/solutionTypes/{solutionType}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
solutionType:
{
Description: Solution Type resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
solutionType:
{
Description: The name of the solution type. ,
Required: False ,
}
string ,
description:
{
Description: Short description of solution type. ,
Required: False ,
}
string ,
supportedAzureRegions:
{
Description: The locations this solution is supported in. ,
Required: False ,
}
[
string ,
]
,
solutionSettings:
{
Description: Array of solution settings and its description. ,
Required: False ,
}
[
{
name:
{
Description: The name of the solution setting property. ,
Required: True ,
}
string ,
displayName:
{
Description: The UI friendly name of the solution setting property. ,
Required: True ,
}
string ,
type:
{
Description: Type of the solution setting property, represented as a string. ,
Required: True ,
}
string ,
description:
{
Description: Description of solution setting property. ,
Required: True ,
}
string ,
allowedValues:
{
Description: Array of allowed values for this solution settings property. ,
Required: True ,
}
[
string ,
]
,
defaultValue:
{
Description: Default value for this solution settings property. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}