Microsoft.DelegatedNetwork (preview:2023-06-27)

2025/09/19 • 19 new, 19 deleted methods

Controller_GetDetails (new)
Description :  Gets details about the specified dnc controller.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/controller/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc controller resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
dncAppId:
{
Description: dnc application id should be used by customer to authenticate with dnc gateway. ,
Required: False ,
}
string ,
dncTenantId:
{
Description: tenant id of dnc application id ,
Required: False ,
}
string ,
dncEndpoint:
{
Description: dnc endpoint url that customers can use to connect to ,
Required: False ,
}
string ,
purpose:
{
Description: The purpose of the dnc controller resource. ,
Enum:
{
test: No description available. ,
prod: 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 ,
}
,
]
,
}
,
}
Controller_Create (new)
Description :  Create a dnc controller
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/controller/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: controller type parameters ,
Required: True ,
}
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc controller resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
dncAppId:
{
Description: dnc application id should be used by customer to authenticate with dnc gateway. ,
Required: False ,
}
string ,
dncTenantId:
{
Description: tenant id of dnc application id ,
Required: False ,
}
string ,
dncEndpoint:
{
Description: dnc endpoint url that customers can use to connect to ,
Required: False ,
}
string ,
purpose:
{
Description: The purpose of the dnc controller resource. ,
Enum:
{
test: No description available. ,
prod: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc controller resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
dncAppId:
{
Description: dnc application id should be used by customer to authenticate with dnc gateway. ,
Required: False ,
}
string ,
dncTenantId:
{
Description: tenant id of dnc application id ,
Required: False ,
}
string ,
dncEndpoint:
{
Description: dnc endpoint url that customers can use to connect to ,
Required: False ,
}
string ,
purpose:
{
Description: The purpose of the dnc controller resource. ,
Enum:
{
test: No description available. ,
prod: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc controller resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
dncAppId:
{
Description: dnc application id should be used by customer to authenticate with dnc gateway. ,
Required: False ,
}
string ,
dncTenantId:
{
Description: tenant id of dnc application id ,
Required: False ,
}
string ,
dncEndpoint:
{
Description: dnc endpoint url that customers can use to connect to ,
Required: False ,
}
string ,
purpose:
{
Description: The purpose of the dnc controller resource. ,
Enum:
{
test: No description available. ,
prod: 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 ,
}
,
]
,
}
,
}
Controller_Delete (new)
Description :  Deletes the DNC controller
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/controller/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/controller/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: controller type parameters ,
Required: True ,
}
{
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc controller resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
dncAppId:
{
Description: dnc application id should be used by customer to authenticate with dnc gateway. ,
Required: False ,
}
string ,
dncTenantId:
{
Description: tenant id of dnc application id ,
Required: False ,
}
string ,
dncEndpoint:
{
Description: dnc endpoint url that customers can use to connect to ,
Required: False ,
}
string ,
purpose:
{
Description: The purpose of the dnc controller resource. ,
Enum:
{
test: No description available. ,
prod: 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 ,
}
,
]
,
}
,
}
DelegatedNetwork_ListBySubscription (new)
Description :  Get all the delegatedController resources in a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: An array of Delegated controller resources. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc controller resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
dncAppId:
{
Description: dnc application id should be used by customer to authenticate with dnc gateway. ,
Required: False ,
}
string ,
dncTenantId:
{
Description: tenant id of dnc application id ,
Required: False ,
}
string ,
dncEndpoint:
{
Description: dnc endpoint url that customers can use to connect to ,
Required: False ,
}
string ,
purpose:
{
Description: The purpose of the dnc controller resource. ,
Enum:
{
test: No description available. ,
prod: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of controllers. ,
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 ,
}
,
]
,
}
,
}
DelegatedNetwork_ListByResourceGroup (new)
Description :  Get all the delegatedController resources in a resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: An array of Delegated controller resources. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc controller resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
dncAppId:
{
Description: dnc application id should be used by customer to authenticate with dnc gateway. ,
Required: False ,
}
string ,
dncTenantId:
{
Description: tenant id of dnc application id ,
Required: False ,
}
string ,
dncEndpoint:
{
Description: dnc endpoint url that customers can use to connect to ,
Required: False ,
}
string ,
purpose:
{
Description: The purpose of the dnc controller resource. ,
Enum:
{
test: No description available. ,
prod: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of controllers. ,
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 ,
}
,
]
,
}
,
}
DelegatedSubnetService_GetDetails (new)
Description :  Gets details about the specified dnc DelegatedSubnet Link.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/delegatedSubnets/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc delegated subnet resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subnetDetails:
{
Description: subnet details ,
Required: False ,
}
{
id:
{
Description: subnet arm resource id ,
Required: False ,
}
string ,
}
,
controllerDetails:
{
Description: Properties of the controller. ,
Required: False ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
allocationBlockPrefixSize:
{
Description: Defines prefix size of CIDR blocks allocated to nodes in VnetBlock Mode. Delegated subnet's prefix size should be smaller than this by a minimum of 3. ,
Format: int32 ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
DelegatedSubnetService_PutDetails (new)
Description :  Put delegated subnet resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/delegatedSubnets/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: Delegated subnet details. ,
Required: True ,
}
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc delegated subnet resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subnetDetails:
{
Description: subnet details ,
Required: False ,
}
{
id:
{
Description: subnet arm resource id ,
Required: False ,
}
string ,
}
,
controllerDetails:
{
Description: Properties of the controller. ,
Required: False ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
allocationBlockPrefixSize:
{
Description: Defines prefix size of CIDR blocks allocated to nodes in VnetBlock Mode. Delegated subnet's prefix size should be smaller than this by a minimum of 3. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc delegated subnet resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subnetDetails:
{
Description: subnet details ,
Required: False ,
}
{
id:
{
Description: subnet arm resource id ,
Required: False ,
}
string ,
}
,
controllerDetails:
{
Description: Properties of the controller. ,
Required: False ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
allocationBlockPrefixSize:
{
Description: Defines prefix size of CIDR blocks allocated to nodes in VnetBlock Mode. Delegated subnet's prefix size should be smaller than this by a minimum of 3. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc delegated subnet resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subnetDetails:
{
Description: subnet details ,
Required: False ,
}
{
id:
{
Description: subnet arm resource id ,
Required: False ,
}
string ,
}
,
controllerDetails:
{
Description: Properties of the controller. ,
Required: False ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
allocationBlockPrefixSize:
{
Description: Defines prefix size of CIDR blocks allocated to nodes in VnetBlock Mode. Delegated subnet's prefix size should be smaller than this by a minimum of 3. ,
Format: int32 ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
DelegatedSubnetService_PatchDetails (new)
Description :  Patch delegated subnet resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/delegatedSubnets/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: Delegated subnet details. ,
Required: True ,
}
{
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc delegated subnet resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subnetDetails:
{
Description: subnet details ,
Required: False ,
}
{
id:
{
Description: subnet arm resource id ,
Required: False ,
}
string ,
}
,
controllerDetails:
{
Description: Properties of the controller. ,
Required: False ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
allocationBlockPrefixSize:
{
Description: Defines prefix size of CIDR blocks allocated to nodes in VnetBlock Mode. Delegated subnet's prefix size should be smaller than this by a minimum of 3. ,
Format: int32 ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
DelegatedSubnetService_DeleteDetails (new)
Description :  Delete dnc DelegatedSubnet.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/delegatedSubnets/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
forceDelete:
{
Description: Force delete resource ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DelegatedSubnetService_ListBySubscription (new)
Description :  Get all the DelegatedSubnets resources in a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: An array of DelegatedSubnet resources. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc delegated subnet resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subnetDetails:
{
Description: subnet details ,
Required: False ,
}
{
id:
{
Description: subnet arm resource id ,
Required: False ,
}
string ,
}
,
controllerDetails:
{
Description: Properties of the controller. ,
Required: False ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
allocationBlockPrefixSize:
{
Description: Defines prefix size of CIDR blocks allocated to nodes in VnetBlock Mode. Delegated subnet's prefix size should be smaller than this by a minimum of 3. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of DelegatedSubnet resources. ,
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 ,
}
,
]
,
}
,
}
DelegatedSubnetService_ListByResourceGroup (new)
Description :  Get all the DelegatedSubnets resources in a resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: An array of DelegatedSubnet resources. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc delegated subnet resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subnetDetails:
{
Description: subnet details ,
Required: False ,
}
{
id:
{
Description: subnet arm resource id ,
Required: False ,
}
string ,
}
,
controllerDetails:
{
Description: Properties of the controller. ,
Required: False ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
allocationBlockPrefixSize:
{
Description: Defines prefix size of CIDR blocks allocated to nodes in VnetBlock Mode. Delegated subnet's prefix size should be smaller than this by a minimum of 3. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of DelegatedSubnet resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists all of the available DelegatedNetwork service REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DelegatedNetwork/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). ,
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 ,
}
,
]
,
}
,
}
OrchestratorInstanceService_GetDetails (new)
Description :  Gets details about the orchestrator instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/orchestrators/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of orchestratorInstance resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
orchestratorAppId:
{
Description: AAD ID used with apiserver ,
Required: False ,
}
string ,
orchestratorTenantId:
{
Description: TenantID of server App ID ,
Required: False ,
}
string ,
clusterRootCA:
{
Description: RootCA certificate of kubernetes cluster base64 encoded ,
Required: False ,
}
string ,
apiServerEndpoint:
{
Description: K8s APIServer url. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: private link arm resource id. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
controllerDetails:
{
Description: Properties of the controller. ,
Required: True ,
}
{
id:
{
Description: controller arm resource id ,
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 ,
}
,
]
,
}
,
}
OrchestratorInstanceService_Create (new)
Description :  Create a orchestrator instance
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/orchestrators/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: OrchestratorInstance type parameters ,
Required: True ,
}
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of orchestratorInstance resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
orchestratorAppId:
{
Description: AAD ID used with apiserver ,
Required: False ,
}
string ,
orchestratorTenantId:
{
Description: TenantID of server App ID ,
Required: False ,
}
string ,
clusterRootCA:
{
Description: RootCA certificate of kubernetes cluster base64 encoded ,
Required: False ,
}
string ,
apiServerEndpoint:
{
Description: K8s APIServer url. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: private link arm resource id. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
controllerDetails:
{
Description: Properties of the controller. ,
Required: True ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of orchestratorInstance resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
orchestratorAppId:
{
Description: AAD ID used with apiserver ,
Required: False ,
}
string ,
orchestratorTenantId:
{
Description: TenantID of server App ID ,
Required: False ,
}
string ,
clusterRootCA:
{
Description: RootCA certificate of kubernetes cluster base64 encoded ,
Required: False ,
}
string ,
apiServerEndpoint:
{
Description: K8s APIServer url. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: private link arm resource id. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
controllerDetails:
{
Description: Properties of the controller. ,
Required: True ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of orchestratorInstance resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
orchestratorAppId:
{
Description: AAD ID used with apiserver ,
Required: False ,
}
string ,
orchestratorTenantId:
{
Description: TenantID of server App ID ,
Required: False ,
}
string ,
clusterRootCA:
{
Description: RootCA certificate of kubernetes cluster base64 encoded ,
Required: False ,
}
string ,
apiServerEndpoint:
{
Description: K8s APIServer url. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: private link arm resource id. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
controllerDetails:
{
Description: Properties of the controller. ,
Required: True ,
}
{
id:
{
Description: controller arm resource id ,
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 ,
}
,
]
,
}
,
}
OrchestratorInstanceService_Delete (new)
Description :  Deletes the Orchestrator Instance
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/orchestrators/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
forceDelete:
{
Description: Force delete resource ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OrchestratorInstanceService_Patch (new)
Description :  Update Orchestrator Instance
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/orchestrators/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: OrchestratorInstance update parameters ,
Required: True ,
}
{
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of orchestratorInstance resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
orchestratorAppId:
{
Description: AAD ID used with apiserver ,
Required: False ,
}
string ,
orchestratorTenantId:
{
Description: TenantID of server App ID ,
Required: False ,
}
string ,
clusterRootCA:
{
Description: RootCA certificate of kubernetes cluster base64 encoded ,
Required: False ,
}
string ,
apiServerEndpoint:
{
Description: K8s APIServer url. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: private link arm resource id. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
controllerDetails:
{
Description: Properties of the controller. ,
Required: True ,
}
{
id:
{
Description: controller arm resource id ,
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 ,
}
,
]
,
}
,
}
OrchestratorInstanceService_ListBySubscription (new)
Description :  Get all the orchestratorInstance resources in a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: An array of OrchestratorInstance resources. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of orchestratorInstance resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
orchestratorAppId:
{
Description: AAD ID used with apiserver ,
Required: False ,
}
string ,
orchestratorTenantId:
{
Description: TenantID of server App ID ,
Required: False ,
}
string ,
clusterRootCA:
{
Description: RootCA certificate of kubernetes cluster base64 encoded ,
Required: False ,
}
string ,
apiServerEndpoint:
{
Description: K8s APIServer url. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: private link arm resource id. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
controllerDetails:
{
Description: Properties of the controller. ,
Required: True ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of orchestrators. ,
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 ,
}
,
]
,
}
,
}
OrchestratorInstanceService_ListByResourceGroup (new)
Description :  Get all the OrchestratorInstances resources in a resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: An array of OrchestratorInstance resources. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of orchestratorInstance resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
orchestratorAppId:
{
Description: AAD ID used with apiserver ,
Required: False ,
}
string ,
orchestratorTenantId:
{
Description: TenantID of server App ID ,
Required: False ,
}
string ,
clusterRootCA:
{
Description: RootCA certificate of kubernetes cluster base64 encoded ,
Required: False ,
}
string ,
apiServerEndpoint:
{
Description: K8s APIServer url. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: private link arm resource id. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
controllerDetails:
{
Description: Properties of the controller. ,
Required: True ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of orchestrators. ,
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 ,
}
,
]
,
}
,
}
Controller_GetDetails (removed)
Description :  Gets details about the specified dnc controller.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/controller/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc controller resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
dncAppId:
{
Description: dnc application id should be used by customer to authenticate with dnc gateway. ,
Required: False ,
}
string ,
dncTenantId:
{
Description: tenant id of dnc application id ,
Required: False ,
}
string ,
dncEndpoint:
{
Description: dnc endpoint url that customers can use to connect to ,
Required: False ,
}
string ,
purpose:
{
Description: The purpose of the dnc controller resource. ,
Enum:
{
test: No description available. ,
prod: 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 ,
}
,
]
,
}
,
}
Controller_Create (removed)
Description :  Create a dnc controller
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/controller/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: controller type parameters ,
Required: True ,
}
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc controller resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
dncAppId:
{
Description: dnc application id should be used by customer to authenticate with dnc gateway. ,
Required: False ,
}
string ,
dncTenantId:
{
Description: tenant id of dnc application id ,
Required: False ,
}
string ,
dncEndpoint:
{
Description: dnc endpoint url that customers can use to connect to ,
Required: False ,
}
string ,
purpose:
{
Description: The purpose of the dnc controller resource. ,
Enum:
{
test: No description available. ,
prod: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc controller resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
dncAppId:
{
Description: dnc application id should be used by customer to authenticate with dnc gateway. ,
Required: False ,
}
string ,
dncTenantId:
{
Description: tenant id of dnc application id ,
Required: False ,
}
string ,
dncEndpoint:
{
Description: dnc endpoint url that customers can use to connect to ,
Required: False ,
}
string ,
purpose:
{
Description: The purpose of the dnc controller resource. ,
Enum:
{
test: No description available. ,
prod: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc controller resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
dncAppId:
{
Description: dnc application id should be used by customer to authenticate with dnc gateway. ,
Required: False ,
}
string ,
dncTenantId:
{
Description: tenant id of dnc application id ,
Required: False ,
}
string ,
dncEndpoint:
{
Description: dnc endpoint url that customers can use to connect to ,
Required: False ,
}
string ,
purpose:
{
Description: The purpose of the dnc controller resource. ,
Enum:
{
test: No description available. ,
prod: 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 ,
}
,
]
,
}
,
}
Controller_Delete (removed)
Description :  Deletes the DNC controller
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/controller/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/controller/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: controller type parameters ,
Required: True ,
}
{
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc controller resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
dncAppId:
{
Description: dnc application id should be used by customer to authenticate with dnc gateway. ,
Required: False ,
}
string ,
dncTenantId:
{
Description: tenant id of dnc application id ,
Required: False ,
}
string ,
dncEndpoint:
{
Description: dnc endpoint url that customers can use to connect to ,
Required: False ,
}
string ,
purpose:
{
Description: The purpose of the dnc controller resource. ,
Enum:
{
test: No description available. ,
prod: 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 ,
}
,
]
,
}
,
}
DelegatedNetwork_ListBySubscription (removed)
Description :  Get all the delegatedController resources in a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: An array of Delegated controller resources. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc controller resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
dncAppId:
{
Description: dnc application id should be used by customer to authenticate with dnc gateway. ,
Required: False ,
}
string ,
dncTenantId:
{
Description: tenant id of dnc application id ,
Required: False ,
}
string ,
dncEndpoint:
{
Description: dnc endpoint url that customers can use to connect to ,
Required: False ,
}
string ,
purpose:
{
Description: The purpose of the dnc controller resource. ,
Enum:
{
test: No description available. ,
prod: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of controllers. ,
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 ,
}
,
]
,
}
,
}
DelegatedNetwork_ListByResourceGroup (removed)
Description :  Get all the delegatedController resources in a resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: An array of Delegated controller resources. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc controller resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
dncAppId:
{
Description: dnc application id should be used by customer to authenticate with dnc gateway. ,
Required: False ,
}
string ,
dncTenantId:
{
Description: tenant id of dnc application id ,
Required: False ,
}
string ,
dncEndpoint:
{
Description: dnc endpoint url that customers can use to connect to ,
Required: False ,
}
string ,
purpose:
{
Description: The purpose of the dnc controller resource. ,
Enum:
{
test: No description available. ,
prod: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of controllers. ,
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 ,
}
,
]
,
}
,
}
DelegatedSubnetService_GetDetails (removed)
Description :  Gets details about the specified dnc DelegatedSubnet Link.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/delegatedSubnets/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc delegated subnet resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subnetDetails:
{
Description: subnet details ,
Required: False ,
}
{
id:
{
Description: subnet arm resource id ,
Required: False ,
}
string ,
}
,
controllerDetails:
{
Description: Properties of the controller. ,
Required: False ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
allocationBlockPrefixSize:
{
Description: Defines prefix size of CIDR blocks allocated to nodes in VnetBlock Mode. Delegated subnet's prefix size should be smaller than this by a minimum of 3. ,
Format: int32 ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
DelegatedSubnetService_PutDetails (removed)
Description :  Put delegated subnet resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/delegatedSubnets/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: Delegated subnet details. ,
Required: True ,
}
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc delegated subnet resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subnetDetails:
{
Description: subnet details ,
Required: False ,
}
{
id:
{
Description: subnet arm resource id ,
Required: False ,
}
string ,
}
,
controllerDetails:
{
Description: Properties of the controller. ,
Required: False ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
allocationBlockPrefixSize:
{
Description: Defines prefix size of CIDR blocks allocated to nodes in VnetBlock Mode. Delegated subnet's prefix size should be smaller than this by a minimum of 3. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc delegated subnet resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subnetDetails:
{
Description: subnet details ,
Required: False ,
}
{
id:
{
Description: subnet arm resource id ,
Required: False ,
}
string ,
}
,
controllerDetails:
{
Description: Properties of the controller. ,
Required: False ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
allocationBlockPrefixSize:
{
Description: Defines prefix size of CIDR blocks allocated to nodes in VnetBlock Mode. Delegated subnet's prefix size should be smaller than this by a minimum of 3. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc delegated subnet resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subnetDetails:
{
Description: subnet details ,
Required: False ,
}
{
id:
{
Description: subnet arm resource id ,
Required: False ,
}
string ,
}
,
controllerDetails:
{
Description: Properties of the controller. ,
Required: False ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
allocationBlockPrefixSize:
{
Description: Defines prefix size of CIDR blocks allocated to nodes in VnetBlock Mode. Delegated subnet's prefix size should be smaller than this by a minimum of 3. ,
Format: int32 ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
DelegatedSubnetService_PatchDetails (removed)
Description :  Patch delegated subnet resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/delegatedSubnets/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: Delegated subnet details. ,
Required: True ,
}
{
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc delegated subnet resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subnetDetails:
{
Description: subnet details ,
Required: False ,
}
{
id:
{
Description: subnet arm resource id ,
Required: False ,
}
string ,
}
,
controllerDetails:
{
Description: Properties of the controller. ,
Required: False ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
allocationBlockPrefixSize:
{
Description: Defines prefix size of CIDR blocks allocated to nodes in VnetBlock Mode. Delegated subnet's prefix size should be smaller than this by a minimum of 3. ,
Format: int32 ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
DelegatedSubnetService_DeleteDetails (removed)
Description :  Delete dnc DelegatedSubnet.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/delegatedSubnets/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
forceDelete:
{
Description: Force delete resource ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DelegatedSubnetService_ListBySubscription (removed)
Description :  Get all the DelegatedSubnets resources in a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: An array of DelegatedSubnet resources. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc delegated subnet resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subnetDetails:
{
Description: subnet details ,
Required: False ,
}
{
id:
{
Description: subnet arm resource id ,
Required: False ,
}
string ,
}
,
controllerDetails:
{
Description: Properties of the controller. ,
Required: False ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
allocationBlockPrefixSize:
{
Description: Defines prefix size of CIDR blocks allocated to nodes in VnetBlock Mode. Delegated subnet's prefix size should be smaller than this by a minimum of 3. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of DelegatedSubnet resources. ,
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 ,
}
,
]
,
}
,
}
DelegatedSubnetService_ListByResourceGroup (removed)
Description :  Get all the DelegatedSubnets resources in a resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: An array of DelegatedSubnet resources. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of dnc delegated subnet resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
subnetDetails:
{
Description: subnet details ,
Required: False ,
}
{
id:
{
Description: subnet arm resource id ,
Required: False ,
}
string ,
}
,
controllerDetails:
{
Description: Properties of the controller. ,
Required: False ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
allocationBlockPrefixSize:
{
Description: Defines prefix size of CIDR blocks allocated to nodes in VnetBlock Mode. Delegated subnet's prefix size should be smaller than this by a minimum of 3. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of DelegatedSubnet resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Lists all of the available DelegatedNetwork service REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DelegatedNetwork/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). ,
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 ,
}
,
]
,
}
,
}
OrchestratorInstanceService_GetDetails (removed)
Description :  Gets details about the orchestrator instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/orchestrators/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of orchestratorInstance resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
orchestratorAppId:
{
Description: AAD ID used with apiserver ,
Required: False ,
}
string ,
orchestratorTenantId:
{
Description: TenantID of server App ID ,
Required: False ,
}
string ,
clusterRootCA:
{
Description: RootCA certificate of kubernetes cluster base64 encoded ,
Required: False ,
}
string ,
apiServerEndpoint:
{
Description: K8s APIServer url. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: private link arm resource id. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
controllerDetails:
{
Description: Properties of the controller. ,
Required: True ,
}
{
id:
{
Description: controller arm resource id ,
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 ,
}
,
]
,
}
,
}
OrchestratorInstanceService_Create (removed)
Description :  Create a orchestrator instance
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/orchestrators/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: OrchestratorInstance type parameters ,
Required: True ,
}
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of orchestratorInstance resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
orchestratorAppId:
{
Description: AAD ID used with apiserver ,
Required: False ,
}
string ,
orchestratorTenantId:
{
Description: TenantID of server App ID ,
Required: False ,
}
string ,
clusterRootCA:
{
Description: RootCA certificate of kubernetes cluster base64 encoded ,
Required: False ,
}
string ,
apiServerEndpoint:
{
Description: K8s APIServer url. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: private link arm resource id. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
controllerDetails:
{
Description: Properties of the controller. ,
Required: True ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of orchestratorInstance resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
orchestratorAppId:
{
Description: AAD ID used with apiserver ,
Required: False ,
}
string ,
orchestratorTenantId:
{
Description: TenantID of server App ID ,
Required: False ,
}
string ,
clusterRootCA:
{
Description: RootCA certificate of kubernetes cluster base64 encoded ,
Required: False ,
}
string ,
apiServerEndpoint:
{
Description: K8s APIServer url. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: private link arm resource id. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
controllerDetails:
{
Description: Properties of the controller. ,
Required: True ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of orchestratorInstance resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
orchestratorAppId:
{
Description: AAD ID used with apiserver ,
Required: False ,
}
string ,
orchestratorTenantId:
{
Description: TenantID of server App ID ,
Required: False ,
}
string ,
clusterRootCA:
{
Description: RootCA certificate of kubernetes cluster base64 encoded ,
Required: False ,
}
string ,
apiServerEndpoint:
{
Description: K8s APIServer url. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: private link arm resource id. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
controllerDetails:
{
Description: Properties of the controller. ,
Required: True ,
}
{
id:
{
Description: controller arm resource id ,
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 ,
}
,
]
,
}
,
}
OrchestratorInstanceService_Delete (removed)
Description :  Deletes the Orchestrator Instance
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/orchestrators/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
forceDelete:
{
Description: Force delete resource ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OrchestratorInstanceService_Patch (removed)
Description :  Update Orchestrator Instance
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/orchestrators/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: OrchestratorInstance update parameters ,
Required: True ,
}
{
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of orchestratorInstance resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
orchestratorAppId:
{
Description: AAD ID used with apiserver ,
Required: False ,
}
string ,
orchestratorTenantId:
{
Description: TenantID of server App ID ,
Required: False ,
}
string ,
clusterRootCA:
{
Description: RootCA certificate of kubernetes cluster base64 encoded ,
Required: False ,
}
string ,
apiServerEndpoint:
{
Description: K8s APIServer url. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: private link arm resource id. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
controllerDetails:
{
Description: Properties of the controller. ,
Required: True ,
}
{
id:
{
Description: controller arm resource id ,
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 ,
}
,
]
,
}
,
}
OrchestratorInstanceService_ListBySubscription (removed)
Description :  Get all the orchestratorInstance resources in a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: An array of OrchestratorInstance resources. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of orchestratorInstance resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
orchestratorAppId:
{
Description: AAD ID used with apiserver ,
Required: False ,
}
string ,
orchestratorTenantId:
{
Description: TenantID of server App ID ,
Required: False ,
}
string ,
clusterRootCA:
{
Description: RootCA certificate of kubernetes cluster base64 encoded ,
Required: False ,
}
string ,
apiServerEndpoint:
{
Description: K8s APIServer url. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: private link arm resource id. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
controllerDetails:
{
Description: Properties of the controller. ,
Required: True ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of orchestrators. ,
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 ,
}
,
]
,
}
,
}
OrchestratorInstanceService_ListByResourceGroup (removed)
Description :  Get all the OrchestratorInstances resources in a resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: An array of OrchestratorInstance resources. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
resourceGuid:
{
Description: Resource guid. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The current state of orchestratorInstance resource. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Provisioning: No description available. ,
}
,
Required: False ,
}
enum ,
orchestratorAppId:
{
Description: AAD ID used with apiserver ,
Required: False ,
}
string ,
orchestratorTenantId:
{
Description: TenantID of server App ID ,
Required: False ,
}
string ,
clusterRootCA:
{
Description: RootCA certificate of kubernetes cluster base64 encoded ,
Required: False ,
}
string ,
apiServerEndpoint:
{
Description: K8s APIServer url. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: private link arm resource id. Either one of apiServerEndpoint or privateLinkResourceId can be specified ,
Required: False ,
}
string ,
controllerDetails:
{
Description: Properties of the controller. ,
Required: True ,
}
{
id:
{
Description: controller arm resource id ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of orchestrators. ,
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 ,
}
,
]
,
}
,
}