Microsoft.DevHub (preview:2025-03-01)

2025/03/13 • 28 new methods

IacProfiles_List (new)
Description :  Gets a list of IacProfiles associated with the specified subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of IacProfiles. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a IacProfile. ,
Required: False ,
}
{
githubProfile:
{
Description: GitHub Profile of a IacProfile ,
Required: False ,
}
{
repositoryName:
{
Description: Repository Name ,
Required: False ,
}
string ,
repositoryMainBranch:
{
Description: Repository Main Branch ,
Required: False ,
}
string ,
repositoryOwner:
{
Description: Repository Owner ,
Required: False ,
}
string ,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
branchName:
{
Description: Repository Branch Name ,
Required: False ,
}
string ,
}
,
terraformProfile:
{
Description: Terraform Profile of a IacProfile ,
Required: False ,
}
{
storageAccountSubscription:
{
Description: Terraform Storage Account Subscription ,
Required: False ,
}
string ,
storageAccountResourceGroup:
{
Description: Terraform Storage Account Resource Group ,
Required: False ,
}
string ,
storageAccountName:
{
Description: Terraform Storage Account Name ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Terraform Container Name ,
Required: False ,
}
string ,
}
,
stages:
{
Required: False ,
}
[
{
stageName:
{
Description: Stage Name ,
Required: False ,
}
string ,
dependencies:
{
Required: False ,
}
[
string ,
]
,
gitEnvironment:
{
Required: False ,
}
string ,
}
,
]
,
templates:
{
Required: False ,
}
[
{
templateName:
{
Description: Template Name ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: the source store of the template ,
Required: False ,
}
string ,
instanceStage:
{
Description: the source stage of the template ,
Required: False ,
}
string ,
instanceName:
{
Description: the sample instance name of the template ,
Required: False ,
}
string ,
templateDetails:
{
Required: False ,
}
[
{
productName:
{
Description: The name of the products. ,
Required: False ,
}
string ,
count:
{
Description: Count of the product ,
Format: int32 ,
Required: False ,
}
integer ,
namingConvention:
{
Description: Naming convention of this product ,
Required: False ,
}
string ,
}
,
]
,
quickStartTemplateType:
{
Description: Determines the authorization status of requests. ,
Enum:
{
None: The template has not use quick start template ,
HCI: The template use quick start template of HCI ,
HCIAKS: The template use quick start template of HCI and AKS ,
HCIARCVM: The template use quick start template of HCI and ArcVM ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to the next set of IacProfile results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of IacProfiles. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a IacProfile. ,
Required: False ,
}
{
githubProfile:
{
Description: GitHub Profile of a IacProfile ,
Required: False ,
}
{
repositoryName:
{
Description: Repository Name ,
Required: False ,
}
string ,
repositoryMainBranch:
{
Description: Repository Main Branch ,
Required: False ,
}
string ,
repositoryOwner:
{
Description: Repository Owner ,
Required: False ,
}
string ,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
branchName:
{
Description: Repository Branch Name ,
Required: False ,
}
string ,
}
,
terraformProfile:
{
Description: Terraform Profile of a IacProfile ,
Required: False ,
}
{
storageAccountSubscription:
{
Description: Terraform Storage Account Subscription ,
Required: False ,
}
string ,
storageAccountResourceGroup:
{
Description: Terraform Storage Account Resource Group ,
Required: False ,
}
string ,
storageAccountName:
{
Description: Terraform Storage Account Name ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Terraform Container Name ,
Required: False ,
}
string ,
}
,
stages:
{
Required: False ,
}
[
{
stageName:
{
Description: Stage Name ,
Required: False ,
}
string ,
dependencies:
{
Required: False ,
}
[
string ,
]
,
gitEnvironment:
{
Required: False ,
}
string ,
}
,
]
,
templates:
{
Required: False ,
}
[
{
templateName:
{
Description: Template Name ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: the source store of the template ,
Required: False ,
}
string ,
instanceStage:
{
Description: the source stage of the template ,
Required: False ,
}
string ,
instanceName:
{
Description: the sample instance name of the template ,
Required: False ,
}
string ,
templateDetails:
{
Required: False ,
}
[
{
productName:
{
Description: The name of the products. ,
Required: False ,
}
string ,
count:
{
Description: Count of the product ,
Format: int32 ,
Required: False ,
}
integer ,
namingConvention:
{
Description: Naming convention of this product ,
Required: False ,
}
string ,
}
,
]
,
quickStartTemplateType:
{
Description: Determines the authorization status of requests. ,
Enum:
{
None: The template has not use quick start template ,
HCI: The template use quick start template of HCI ,
HCIAKS: The template use quick start template of HCI and AKS ,
HCIARCVM: The template use quick start template of HCI and ArcVM ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to the next set of IacProfile results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Properties of a IacProfile. ,
Required: False ,
}
{
githubProfile:
{
Description: GitHub Profile of a IacProfile ,
Required: False ,
}
{
repositoryName:
{
Description: Repository Name ,
Required: False ,
}
string ,
repositoryMainBranch:
{
Description: Repository Main Branch ,
Required: False ,
}
string ,
repositoryOwner:
{
Description: Repository Owner ,
Required: False ,
}
string ,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
branchName:
{
Description: Repository Branch Name ,
Required: False ,
}
string ,
}
,
terraformProfile:
{
Description: Terraform Profile of a IacProfile ,
Required: False ,
}
{
storageAccountSubscription:
{
Description: Terraform Storage Account Subscription ,
Required: False ,
}
string ,
storageAccountResourceGroup:
{
Description: Terraform Storage Account Resource Group ,
Required: False ,
}
string ,
storageAccountName:
{
Description: Terraform Storage Account Name ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Terraform Container Name ,
Required: False ,
}
string ,
}
,
stages:
{
Required: False ,
}
[
{
stageName:
{
Description: Stage Name ,
Required: False ,
}
string ,
dependencies:
{
Required: False ,
}
[
string ,
]
,
gitEnvironment:
{
Required: False ,
}
string ,
}
,
]
,
templates:
{
Required: False ,
}
[
{
templateName:
{
Description: Template Name ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: the source store of the template ,
Required: False ,
}
string ,
instanceStage:
{
Description: the source stage of the template ,
Required: False ,
}
string ,
instanceName:
{
Description: the sample instance name of the template ,
Required: False ,
}
string ,
templateDetails:
{
Required: False ,
}
[
{
productName:
{
Description: The name of the products. ,
Required: False ,
}
string ,
count:
{
Description: Count of the product ,
Format: int32 ,
Required: False ,
}
integer ,
namingConvention:
{
Description: Naming convention of this product ,
Required: False ,
}
string ,
}
,
]
,
quickStartTemplateType:
{
Description: Determines the authorization status of requests. ,
Enum:
{
None: The template has not use quick start template ,
HCI: The template use quick start template of HCI ,
HCIAKS: The template use quick start template of HCI and AKS ,
HCIARCVM: The template use quick start template of HCI and ArcVM ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
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 ,
}
,
]
,
}
,
}
IacProfiles_CreateOrUpdate (new)
Description :  Creates or updates a IacProfile
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/iacProfiles/{iacProfileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
iacProfileName:
{
Description: The name of the IacProfile. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Properties of a IacProfile. ,
Required: False ,
}
{
githubProfile:
{
Description: GitHub Profile of a IacProfile ,
Required: False ,
}
{
repositoryName:
{
Description: Repository Name ,
Required: False ,
}
string ,
repositoryMainBranch:
{
Description: Repository Main Branch ,
Required: False ,
}
string ,
repositoryOwner:
{
Description: Repository Owner ,
Required: False ,
}
string ,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
branchName:
{
Description: Repository Branch Name ,
Required: False ,
}
string ,
}
,
terraformProfile:
{
Description: Terraform Profile of a IacProfile ,
Required: False ,
}
{
storageAccountSubscription:
{
Description: Terraform Storage Account Subscription ,
Required: False ,
}
string ,
storageAccountResourceGroup:
{
Description: Terraform Storage Account Resource Group ,
Required: False ,
}
string ,
storageAccountName:
{
Description: Terraform Storage Account Name ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Terraform Container Name ,
Required: False ,
}
string ,
}
,
stages:
{
Required: False ,
}
[
{
stageName:
{
Description: Stage Name ,
Required: False ,
}
string ,
dependencies:
{
Required: False ,
}
[
string ,
]
,
gitEnvironment:
{
Required: False ,
}
string ,
}
,
]
,
templates:
{
Required: False ,
}
[
{
templateName:
{
Description: Template Name ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: the source store of the template ,
Required: False ,
}
string ,
instanceStage:
{
Description: the source stage of the template ,
Required: False ,
}
string ,
instanceName:
{
Description: the sample instance name of the template ,
Required: False ,
}
string ,
templateDetails:
{
Required: False ,
}
[
{
productName:
{
Description: The name of the products. ,
Required: False ,
}
string ,
count:
{
Description: Count of the product ,
Format: int32 ,
Required: False ,
}
integer ,
namingConvention:
{
Description: Naming convention of this product ,
Required: False ,
}
string ,
}
,
]
,
quickStartTemplateType:
{
Description: Determines the authorization status of requests. ,
Enum:
{
None: The template has not use quick start template ,
HCI: The template use quick start template of HCI ,
HCIAKS: The template use quick start template of HCI and AKS ,
HCIARCVM: The template use quick start template of HCI and ArcVM ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a IacProfile. ,
Required: False ,
}
{
githubProfile:
{
Description: GitHub Profile of a IacProfile ,
Required: False ,
}
{
repositoryName:
{
Description: Repository Name ,
Required: False ,
}
string ,
repositoryMainBranch:
{
Description: Repository Main Branch ,
Required: False ,
}
string ,
repositoryOwner:
{
Description: Repository Owner ,
Required: False ,
}
string ,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
branchName:
{
Description: Repository Branch Name ,
Required: False ,
}
string ,
}
,
terraformProfile:
{
Description: Terraform Profile of a IacProfile ,
Required: False ,
}
{
storageAccountSubscription:
{
Description: Terraform Storage Account Subscription ,
Required: False ,
}
string ,
storageAccountResourceGroup:
{
Description: Terraform Storage Account Resource Group ,
Required: False ,
}
string ,
storageAccountName:
{
Description: Terraform Storage Account Name ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Terraform Container Name ,
Required: False ,
}
string ,
}
,
stages:
{
Required: False ,
}
[
{
stageName:
{
Description: Stage Name ,
Required: False ,
}
string ,
dependencies:
{
Required: False ,
}
[
string ,
]
,
gitEnvironment:
{
Required: False ,
}
string ,
}
,
]
,
templates:
{
Required: False ,
}
[
{
templateName:
{
Description: Template Name ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: the source store of the template ,
Required: False ,
}
string ,
instanceStage:
{
Description: the source stage of the template ,
Required: False ,
}
string ,
instanceName:
{
Description: the sample instance name of the template ,
Required: False ,
}
string ,
templateDetails:
{
Required: False ,
}
[
{
productName:
{
Description: The name of the products. ,
Required: False ,
}
string ,
count:
{
Description: Count of the product ,
Format: int32 ,
Required: False ,
}
integer ,
namingConvention:
{
Description: Naming convention of this product ,
Required: False ,
}
string ,
}
,
]
,
quickStartTemplateType:
{
Description: Determines the authorization status of requests. ,
Enum:
{
None: The template has not use quick start template ,
HCI: The template use quick start template of HCI ,
HCIAKS: The template use quick start template of HCI and AKS ,
HCIARCVM: The template use quick start template of HCI and ArcVM ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of a IacProfile. ,
Required: False ,
}
{
githubProfile:
{
Description: GitHub Profile of a IacProfile ,
Required: False ,
}
{
repositoryName:
{
Description: Repository Name ,
Required: False ,
}
string ,
repositoryMainBranch:
{
Description: Repository Main Branch ,
Required: False ,
}
string ,
repositoryOwner:
{
Description: Repository Owner ,
Required: False ,
}
string ,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
branchName:
{
Description: Repository Branch Name ,
Required: False ,
}
string ,
}
,
terraformProfile:
{
Description: Terraform Profile of a IacProfile ,
Required: False ,
}
{
storageAccountSubscription:
{
Description: Terraform Storage Account Subscription ,
Required: False ,
}
string ,
storageAccountResourceGroup:
{
Description: Terraform Storage Account Resource Group ,
Required: False ,
}
string ,
storageAccountName:
{
Description: Terraform Storage Account Name ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Terraform Container Name ,
Required: False ,
}
string ,
}
,
stages:
{
Required: False ,
}
[
{
stageName:
{
Description: Stage Name ,
Required: False ,
}
string ,
dependencies:
{
Required: False ,
}
[
string ,
]
,
gitEnvironment:
{
Required: False ,
}
string ,
}
,
]
,
templates:
{
Required: False ,
}
[
{
templateName:
{
Description: Template Name ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: the source store of the template ,
Required: False ,
}
string ,
instanceStage:
{
Description: the source stage of the template ,
Required: False ,
}
string ,
instanceName:
{
Description: the sample instance name of the template ,
Required: False ,
}
string ,
templateDetails:
{
Required: False ,
}
[
{
productName:
{
Description: The name of the products. ,
Required: False ,
}
string ,
count:
{
Description: Count of the product ,
Format: int32 ,
Required: False ,
}
integer ,
namingConvention:
{
Description: Naming convention of this product ,
Required: False ,
}
string ,
}
,
]
,
quickStartTemplateType:
{
Description: Determines the authorization status of requests. ,
Enum:
{
None: The template has not use quick start template ,
HCI: The template use quick start template of HCI ,
HCIAKS: The template use quick start template of HCI and AKS ,
HCIARCVM: The template use quick start template of HCI and ArcVM ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
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 ,
}
,
]
,
}
,
}
IacProfiles_Delete (new)
Description :  Deletes a IacProfile
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IacProfiles_UpdateTags (new)
Description :  Updates tags on a IacProfile.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/iacProfiles/{iacProfileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
iacProfileName:
{
Description: The name of the IacProfile. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update TagsObject Tags operation. ,
Required: True ,
}
{
tags:
{
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a IacProfile. ,
Required: False ,
}
{
githubProfile:
{
Description: GitHub Profile of a IacProfile ,
Required: False ,
}
{
repositoryName:
{
Description: Repository Name ,
Required: False ,
}
string ,
repositoryMainBranch:
{
Description: Repository Main Branch ,
Required: False ,
}
string ,
repositoryOwner:
{
Description: Repository Owner ,
Required: False ,
}
string ,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
branchName:
{
Description: Repository Branch Name ,
Required: False ,
}
string ,
}
,
terraformProfile:
{
Description: Terraform Profile of a IacProfile ,
Required: False ,
}
{
storageAccountSubscription:
{
Description: Terraform Storage Account Subscription ,
Required: False ,
}
string ,
storageAccountResourceGroup:
{
Description: Terraform Storage Account Resource Group ,
Required: False ,
}
string ,
storageAccountName:
{
Description: Terraform Storage Account Name ,
Required: False ,
}
string ,
storageContainerName:
{
Description: Terraform Container Name ,
Required: False ,
}
string ,
}
,
stages:
{
Required: False ,
}
[
{
stageName:
{
Description: Stage Name ,
Required: False ,
}
string ,
dependencies:
{
Required: False ,
}
[
string ,
]
,
gitEnvironment:
{
Required: False ,
}
string ,
}
,
]
,
templates:
{
Required: False ,
}
[
{
templateName:
{
Description: Template Name ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: the source store of the template ,
Required: False ,
}
string ,
instanceStage:
{
Description: the source stage of the template ,
Required: False ,
}
string ,
instanceName:
{
Description: the sample instance name of the template ,
Required: False ,
}
string ,
templateDetails:
{
Required: False ,
}
[
{
productName:
{
Description: The name of the products. ,
Required: False ,
}
string ,
count:
{
Description: Count of the product ,
Format: int32 ,
Required: False ,
}
integer ,
namingConvention:
{
Description: Naming convention of this product ,
Required: False ,
}
string ,
}
,
]
,
quickStartTemplateType:
{
Description: Determines the authorization status of requests. ,
Enum:
{
None: The template has not use quick start template ,
HCI: The template use quick start template of HCI ,
HCIAKS: The template use quick start template of HCI and AKS ,
HCIARCVM: The template use quick start template of HCI and ArcVM ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
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 ,
}
,
]
,
}
,
}
IacProfiles_Export (new)
Description :  Export a template
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/iacProfiles/{iacProfileName}/export
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
iacProfileName:
{
Description: The name of the IacProfile. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
templateName:
{
Description: Template Name ,
Required: False ,
}
string ,
resourceGroupIds:
{
Required: False ,
}
[
string ,
]
,
siteId:
{
Required: False ,
}
string ,
instanceName:
{
Required: False ,
}
string ,
instanceStage:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
prLink:
{
Description: The link of the pull request. ,
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 ,
}
,
]
,
}
,
}
IacProfiles_Scale (new)
Description :  Scale by template
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/iacProfiles/{iacProfileName}/scale
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
iacProfileName:
{
Description: The name of the IacProfile. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
templateName:
{
Description: Template Name ,
Required: False ,
}
string ,
scaleRequirement:
{
Required: False ,
}
[
{
region:
{
Description: The region of the store ,
Required: False ,
}
string ,
stage:
{
Description: The stage of the store ,
Required: False ,
}
string ,
numberOfStore:
{
Description: Number of the store ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (200)

{
prLink:
{
Description: The link of the pull request. ,
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 ,
}
,
]
,
}
,
}
IacProfiles_Sync (new)
Description :  Sync template
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Template_List (new)
Description :  Gets a list of supported templates.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of Template. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a Template. ,
Required: False ,
}
{
templateName:
{
Description: The name of the template. ,
Required: False ,
}
string ,
defaultVersion:
{
Description: The default version of the template. ,
Required: False ,
}
string ,
versions:
{
Description: The valid versions of the template. ,
Required: False ,
}
[
string ,
]
,
description:
{
Description: Description of the template ,
Required: False ,
}
string ,
templateType:
{
Description: The type of the template. ,
Enum:
{
deployment: Deployment template type. ,
manifest: Manifest template type. ,
workflow: Workflow template type. ,
dockerfile: Dockerfile template type. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of Template results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Properties of a Template. ,
Required: False ,
}
{
templateName:
{
Description: The name of the template. ,
Required: False ,
}
string ,
defaultVersion:
{
Description: The default version of the template. ,
Required: False ,
}
string ,
versions:
{
Description: The valid versions of the template. ,
Required: False ,
}
[
string ,
]
,
description:
{
Description: Description of the template ,
Required: False ,
}
string ,
templateType:
{
Description: The type of the template. ,
Enum:
{
deployment: Deployment template type. ,
manifest: Manifest template type. ,
workflow: Workflow template type. ,
dockerfile: Dockerfile template type. ,
}
,
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 ,
}
,
]
,
}
,
}
VersionedTemplate_List (new)
Description :  Gets a list of VersionedTemplate.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of VersionedTemplates. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a VersionedTemplate. ,
Required: False ,
}
{
version:
{
Description: The version of the template. ,
Required: False ,
}
string ,
templateType:
{
Description: The type of the template. ,
Enum:
{
deployment: Deployment template type. ,
manifest: Manifest template type. ,
workflow: Workflow template type. ,
dockerfile: Dockerfile template type. ,
}
,
Required: False ,
}
enum ,
parameters:
{
Description: The template parameters. ,
Required: False ,
}
[
{
name:
{
Description: The paramater name. ,
Required: False ,
}
string ,
description:
{
Description: Description of what the paramater is used for. ,
Required: False ,
}
string ,
parameterType:
{
Description: The type of the template parameter. ,
Enum:
{
string: string parameter type. ,
bool: boolean parameter type. ,
int: int parameter type. ,
float: float parameter type. ,
object: object parameter type. ,
}
,
Required: False ,
}
enum ,
parameterKind:
{
Description: The type of the template parameter. ,
Enum:
{
azureContainerRegistry: azure container registry name ,
azureKeyvaultUri: azure keyvault uri ,
azureManagedCluster: azure managed cluster name ,
azureResourceGroup: azure resource group ,
azureServiceConnection: azure service connection ,
containerImageName: container image name ,
containerImageVersion: container image version ,
clusterResourceType: cluster resource type ,
dirPath: directory path ,
dockerFileName: dockerfile name ,
envVarMap: environment variables in the form of a json object ,
filePath: file path ,
flag: boolean flag ,
helmChartOverrides: helm overrides in the form of a string key1=value1,key2=value2 ,
imagePullPolicy: kubernetes deployment image pull policy ,
ingressHostName: kubernetes ingress host name ,
kubernetesNamespace: kubernetes namespace ,
kubernetesProbeHttpPath: kubernetes probe http path ,
kubernetesProbePeriod: kubernetes probe period ,
kubernetesProbeTimeout: kubernetes probe timeout ,
kubernetesProbeThreshold: kubernetes probe threshold ,
kubernetesProbeType: kubernetes probe type ,
kubernetesProbeDelay: kubernetes probe delay ,
kubernetesResourceLimit: kubernetes resource limit ,
kubernetesResourceName: kubernetes resource name ,
kubernetesResourceRequest: kubernetes resource request ,
label: kubernetes label value ,
port: service port ,
repositoryBranch: repository branch name ,
workflowName: workflow name ,
replicaCount: kubernetes replica count ,
scalingResourceType: kubernetes scaling resource type ,
scalingResourceUtilization: kubernetes resource utilization type ,
resourceLimit: kubernetes resource limit ,
workflowAuthType: workflow authentication type ,
}
,
Required: False ,
}
enum ,
required:
{
Description: Whether the parameter is required. ,
Required: False ,
}
boolean ,
default:
{
Description: A reference to a default parameter value or a reference parameter to take the value from. ,
Required: False ,
}
{
value:
{
Description: The default value for this parameter. ,
Required: False ,
}
string ,
referenceParameter:
{
Description: The Parameter to reference a value from. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of VersionedTemplate results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevHub/templates/{templateName}/versions/{templateVersion}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
templateName:
{
Description: The name of the Template. ,
Required: True ,
}
string ,
templateVersion:
{
Description: The template version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a VersionedTemplate. ,
Required: False ,
}
{
version:
{
Description: The version of the template. ,
Required: False ,
}
string ,
templateType:
{
Description: The type of the template. ,
Enum:
{
deployment: Deployment template type. ,
manifest: Manifest template type. ,
workflow: Workflow template type. ,
dockerfile: Dockerfile template type. ,
}
,
Required: False ,
}
enum ,
parameters:
{
Description: The template parameters. ,
Required: False ,
}
[
{
name:
{
Description: The paramater name. ,
Required: False ,
}
string ,
description:
{
Description: Description of what the paramater is used for. ,
Required: False ,
}
string ,
parameterType:
{
Description: The type of the template parameter. ,
Enum:
{
string: string parameter type. ,
bool: boolean parameter type. ,
int: int parameter type. ,
float: float parameter type. ,
object: object parameter type. ,
}
,
Required: False ,
}
enum ,
parameterKind:
{
Description: The type of the template parameter. ,
Enum:
{
azureContainerRegistry: azure container registry name ,
azureKeyvaultUri: azure keyvault uri ,
azureManagedCluster: azure managed cluster name ,
azureResourceGroup: azure resource group ,
azureServiceConnection: azure service connection ,
containerImageName: container image name ,
containerImageVersion: container image version ,
clusterResourceType: cluster resource type ,
dirPath: directory path ,
dockerFileName: dockerfile name ,
envVarMap: environment variables in the form of a json object ,
filePath: file path ,
flag: boolean flag ,
helmChartOverrides: helm overrides in the form of a string key1=value1,key2=value2 ,
imagePullPolicy: kubernetes deployment image pull policy ,
ingressHostName: kubernetes ingress host name ,
kubernetesNamespace: kubernetes namespace ,
kubernetesProbeHttpPath: kubernetes probe http path ,
kubernetesProbePeriod: kubernetes probe period ,
kubernetesProbeTimeout: kubernetes probe timeout ,
kubernetesProbeThreshold: kubernetes probe threshold ,
kubernetesProbeType: kubernetes probe type ,
kubernetesProbeDelay: kubernetes probe delay ,
kubernetesResourceLimit: kubernetes resource limit ,
kubernetesResourceName: kubernetes resource name ,
kubernetesResourceRequest: kubernetes resource request ,
label: kubernetes label value ,
port: service port ,
repositoryBranch: repository branch name ,
workflowName: workflow name ,
replicaCount: kubernetes replica count ,
scalingResourceType: kubernetes scaling resource type ,
scalingResourceUtilization: kubernetes resource utilization type ,
resourceLimit: kubernetes resource limit ,
workflowAuthType: workflow authentication type ,
}
,
Required: False ,
}
enum ,
required:
{
Description: Whether the parameter is required. ,
Required: False ,
}
boolean ,
default:
{
Description: A reference to a default parameter value or a reference parameter to take the value from. ,
Required: False ,
}
{
value:
{
Description: The default value for this parameter. ,
Required: False ,
}
string ,
referenceParameter:
{
Description: The Parameter to reference a value from. ,
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 ,
}
,
]
,
}
,
}
VersionedTemplate_Generate (new)
Description :  Generates a VersionedTemplate.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DevHub/templates/{templateName}/versions/{templateVersion}/generate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
templateName:
{
Description: The name of the Template. ,
Required: True ,
}
string ,
templateVersion:
{
Description: The template version. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
object ,
}

⚐ Response (200)

{
generatedFiles:
{
Description: files returned as a map ,
Required: False ,
}
object ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GitHubOAuth (new)
Description :  Gets GitHubOAuth info used to authenticate users with the Developer Hub GitHub App.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/githuboauth/default/getGitHubOAuthInfo
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
parameters:
{
Required: False ,
}
{
redirectUrl:
{
Description: The URL the client will redirect to on successful authentication. If empty, no redirect will occur. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
authURL:
{
Description: URL for authorizing the Developer Hub GitHub App ,
Required: False ,
}
string ,
token:
{
Description: OAuth token used to make calls to GitHub ,
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 ,
}
,
]
,
}
,
}
GitHubOAuthCallback (new)
Description :  Callback URL to hit once authenticated with GitHub App to have the service store the OAuth token.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/githuboauth/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
code:
{
Description: The code response from authenticating the GitHub App. ,
Required: True ,
}
string ,
state:
{
Description: The state response from authenticating the GitHub App. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a workflow. ,
Required: False ,
}
{
username:
{
Description: user making request ,
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 ,
}
,
]
,
}
,
}
ListGitHubOAuth (new)
Description :  Callback URL to hit once authenticated with GitHub App to have the service store the OAuth token.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Singleton list response containing one GitHubOAuthResponse response ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a workflow. ,
Required: False ,
}
{
username:
{
Description: user making request ,
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 ,
}
,
]
,
}
,
}
Workflow_List (new)
Description :  Gets a list of workflows associated with the specified subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of workflows. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a workflow. ,
Required: False ,
}
{
githubWorkflowProfile:
{
Description: Profile of a github workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: Repository Owner ,
Required: False ,
}
string ,
repositoryName:
{
Description: Repository Name ,
Required: False ,
}
string ,
branchName:
{
Description: Repository Branch Name ,
Required: False ,
}
string ,
dockerfile:
{
Description: Path to the Dockerfile within the repository. ,
Required: False ,
}
string ,
dockerBuildContext:
{
Description: Path to Dockerfile Build Context within the repository. ,
Required: False ,
}
string ,
deploymentProperties:
{
Description: Deployment details of the repository associated with the workflow. ,
Required: False ,
}
{
manifestType:
{
Description: Determines the type of manifests within the repository. ,
Enum:
{
helm: Repositories using helm ,
kube: Repositories using kubernetes manifests ,
kustomize: No description available. ,
}
,
Required: False ,
}
enum ,
kubeManifestLocations:
{
Required: False ,
}
[
string ,
]
,
helmChartPath:
{
Description: Helm chart directory path in repository. ,
Required: False ,
}
string ,
helmValues:
{
Description: Helm Values.yaml file location in repository. ,
Required: False ,
}
string ,
overrides:
{
Description: Manifest override values. ,
Required: False ,
}
object ,
}
,
namespace:
{
Description: Kubernetes namespace the application is deployed to. ,
Required: False ,
}
string ,
acr:
{
Description: Information on the azure container registry ,
Required: False ,
}
{
acrSubscriptionId:
{
Description: ACR subscription id ,
Required: False ,
}
string ,
acrResourceGroup:
{
Description: ACR resource group ,
Required: False ,
}
string ,
acrRegistryName:
{
Description: ACR registry ,
Required: False ,
}
string ,
acrRepositoryName:
{
Description: ACR repository ,
Required: False ,
}
string ,
}
,
oidcCredentials:
{
Description: The fields needed for OIDC with GitHub. ,
Required: False ,
}
{
azureClientId:
{
Description: Azure Application Client ID ,
Required: False ,
}
string ,
azureTenantId:
{
Description: Azure Directory (tenant) ID ,
Required: False ,
}
string ,
}
,
aksResourceId:
{
Description: The Azure Kubernetes Cluster Resource the application will be deployed to. ,
Required: False ,
}
string ,
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
}
,
artifactGenerationProperties:
{
Description: Properties for generating artifacts like dockerfile and manifests. ,
Required: False ,
}
{
generationLanguage:
{
Description: The programming language used. ,
Enum:
{
clojure: clojure language ,
csharp: csharp language ,
erlang: erlang language ,
go: go language ,
gomodule: gomodule language ,
gradle: gradle language ,
java: java language ,
javascript: javascript language ,
php: php language ,
python: python language ,
ruby: ruby language ,
rust: rust language ,
swift: swift language ,
}
,
Required: False ,
}
enum ,
languageVersion:
{
Description: The version of the language image used for execution in the generated dockerfile. ,
Required: False ,
}
string ,
builderVersion:
{
Description: The version of the language image used for building the code in the generated dockerfile. ,
Required: False ,
}
string ,
port:
{
Description: The port the application is exposed on. ,
Required: False ,
}
string ,
appName:
{
Description: The name of the app. ,
Required: False ,
}
string ,
dockerfileOutputDirectory:
{
Description: The directory to output the generated Dockerfile to. ,
Required: False ,
}
string ,
manifestOutputDirectory:
{
Description: The directory to output the generated manifests to. ,
Required: False ,
}
string ,
dockerfileGenerationMode:
{
Description: The mode of generation to be used for generating Dockerfiles. ,
Enum:
{
enabled: Dockerfiles will be generated ,
disabled: Dockerfiles will not be generated ,
}
,
Required: False ,
}
enum ,
manifestGenerationMode:
{
Description: The mode of generation to be used for generating Manifest. ,
Enum:
{
enabled: Manifests will be generated ,
disabled: Manifests will not be generated ,
}
,
Required: False ,
}
enum ,
manifestType:
{
Description: Determines the type of manifests to be generated. ,
Enum:
{
helm: Helm manifests ,
kube: Kubernetes manifests ,
}
,
Required: False ,
}
enum ,
imageName:
{
Description: The name of the image to be generated. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace to deploy the application to. ,
Required: False ,
}
string ,
imageTag:
{
Description: The tag to apply to the generated image. ,
Required: False ,
}
string ,
}
,
azurePipelineProfile:
{
Description: Profile of an azure pipeline. ,
Required: False ,
}
{
repository:
{
Description: Details of the ADO repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
adoOrganization:
{
Description: The name of the Azure DevOps organization the pipeline is associated with. ,
Required: False ,
}
string ,
projectName:
{
Description: The name of the project the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
armServiceConnection:
{
Description: The name of the ARM Service Connection the pipeline is associated with. ,
Required: False ,
}
string ,
build:
{
Description: Build details of the repository associated with the workflow. ,
Required: False ,
}
{
dockerfile:
{
Description: Path to the Dockerfile within the repository. ,
Required: False ,
}
string ,
dockerBuildContext:
{
Description: Path to Dockerfile Build Context within the repository. ,
Required: False ,
}
string ,
}
,
deployment:
{
Description: Deployment details of the repository associated with the workflow. ,
Required: False ,
}
{
manifestType:
{
Description: Determines the type of manifests within the repository. ,
Enum:
{
helm: Repositories using helm ,
kube: Repositories using kubernetes manifests ,
kustomize: No description available. ,
}
,
Required: False ,
}
enum ,
kubeManifestLocations:
{
Required: False ,
}
[
string ,
]
,
helmChartPath:
{
Description: Helm chart directory path in repository. ,
Required: False ,
}
string ,
helmValues:
{
Description: Helm Values.yaml file location in repository. ,
Required: False ,
}
string ,
overrides:
{
Description: Manifest override values. ,
Required: False ,
}
object ,
}
,
namespace:
{
Description: Kubernetes namespace the application is deployed to. ,
Required: False ,
}
string ,
acr:
{
Description: Resource identifier for azure container registry repository associated with the workflow. ,
Format: arm-id ,
Required: False ,
}
string ,
clusterId:
{
Description: The Azure Kubernetes Cluster Resource the application will be deployed to. ,
Format: arm-id ,
Required: False ,
}
string ,
pullRequest:
{
Description: Details of the pull request containing the workflow. ,
Required: False ,
}
{
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
}
,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
}
,
templateWorkflowProfile:
{
Description: Profile of an template workflow. ,
Required: False ,
}
{
repositoryProvider:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
github: GitHub repository provider type. ,
ado: ADO repository provider type. ,
}
,
Required: False ,
}
enum ,
workflowTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
deploymentTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
dockerfileTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
manifestTemplates:
{
Required: False ,
}
[
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
]
,
gitHubProviderProfile:
{
Description: Details of the GitHub repository and credentials associated with the workflow. ,
Required: False ,
}
{
repository:
{
Description: Details of the GitHub repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
}
,
oidcCredentials:
{
Description: The fields needed for OIDC with GitHub. ,
Required: False ,
}
{
azureClientId:
{
Description: Azure Application Client ID ,
Required: False ,
}
string ,
azureTenantId:
{
Description: Azure Directory (tenant) ID ,
Required: False ,
}
string ,
}
,
}
,
adoProviderProfile:
{
Description: Details of the GitHub repository associated with the workflow. ,
Required: False ,
}
{
repository:
{
Description: Details of the ADO repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
adoOrganization:
{
Description: The name of the Azure DevOps organization the pipeline is associated with. ,
Required: False ,
}
string ,
projectName:
{
Description: The name of the project the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
armServiceConnection:
{
Description: The name of the ARM Service Connection the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
pullRequest:
{
Description: Details of the pull request containing the workflow. ,
Required: False ,
}
{
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
}
,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of workflow results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of workflows. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of a workflow. ,
Required: False ,
}
{
githubWorkflowProfile:
{
Description: Profile of a github workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: Repository Owner ,
Required: False ,
}
string ,
repositoryName:
{
Description: Repository Name ,
Required: False ,
}
string ,
branchName:
{
Description: Repository Branch Name ,
Required: False ,
}
string ,
dockerfile:
{
Description: Path to the Dockerfile within the repository. ,
Required: False ,
}
string ,
dockerBuildContext:
{
Description: Path to Dockerfile Build Context within the repository. ,
Required: False ,
}
string ,
deploymentProperties:
{
Description: Deployment details of the repository associated with the workflow. ,
Required: False ,
}
{
manifestType:
{
Description: Determines the type of manifests within the repository. ,
Enum:
{
helm: Repositories using helm ,
kube: Repositories using kubernetes manifests ,
kustomize: No description available. ,
}
,
Required: False ,
}
enum ,
kubeManifestLocations:
{
Required: False ,
}
[
string ,
]
,
helmChartPath:
{
Description: Helm chart directory path in repository. ,
Required: False ,
}
string ,
helmValues:
{
Description: Helm Values.yaml file location in repository. ,
Required: False ,
}
string ,
overrides:
{
Description: Manifest override values. ,
Required: False ,
}
object ,
}
,
namespace:
{
Description: Kubernetes namespace the application is deployed to. ,
Required: False ,
}
string ,
acr:
{
Description: Information on the azure container registry ,
Required: False ,
}
{
acrSubscriptionId:
{
Description: ACR subscription id ,
Required: False ,
}
string ,
acrResourceGroup:
{
Description: ACR resource group ,
Required: False ,
}
string ,
acrRegistryName:
{
Description: ACR registry ,
Required: False ,
}
string ,
acrRepositoryName:
{
Description: ACR repository ,
Required: False ,
}
string ,
}
,
oidcCredentials:
{
Description: The fields needed for OIDC with GitHub. ,
Required: False ,
}
{
azureClientId:
{
Description: Azure Application Client ID ,
Required: False ,
}
string ,
azureTenantId:
{
Description: Azure Directory (tenant) ID ,
Required: False ,
}
string ,
}
,
aksResourceId:
{
Description: The Azure Kubernetes Cluster Resource the application will be deployed to. ,
Required: False ,
}
string ,
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
}
,
artifactGenerationProperties:
{
Description: Properties for generating artifacts like dockerfile and manifests. ,
Required: False ,
}
{
generationLanguage:
{
Description: The programming language used. ,
Enum:
{
clojure: clojure language ,
csharp: csharp language ,
erlang: erlang language ,
go: go language ,
gomodule: gomodule language ,
gradle: gradle language ,
java: java language ,
javascript: javascript language ,
php: php language ,
python: python language ,
ruby: ruby language ,
rust: rust language ,
swift: swift language ,
}
,
Required: False ,
}
enum ,
languageVersion:
{
Description: The version of the language image used for execution in the generated dockerfile. ,
Required: False ,
}
string ,
builderVersion:
{
Description: The version of the language image used for building the code in the generated dockerfile. ,
Required: False ,
}
string ,
port:
{
Description: The port the application is exposed on. ,
Required: False ,
}
string ,
appName:
{
Description: The name of the app. ,
Required: False ,
}
string ,
dockerfileOutputDirectory:
{
Description: The directory to output the generated Dockerfile to. ,
Required: False ,
}
string ,
manifestOutputDirectory:
{
Description: The directory to output the generated manifests to. ,
Required: False ,
}
string ,
dockerfileGenerationMode:
{
Description: The mode of generation to be used for generating Dockerfiles. ,
Enum:
{
enabled: Dockerfiles will be generated ,
disabled: Dockerfiles will not be generated ,
}
,
Required: False ,
}
enum ,
manifestGenerationMode:
{
Description: The mode of generation to be used for generating Manifest. ,
Enum:
{
enabled: Manifests will be generated ,
disabled: Manifests will not be generated ,
}
,
Required: False ,
}
enum ,
manifestType:
{
Description: Determines the type of manifests to be generated. ,
Enum:
{
helm: Helm manifests ,
kube: Kubernetes manifests ,
}
,
Required: False ,
}
enum ,
imageName:
{
Description: The name of the image to be generated. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace to deploy the application to. ,
Required: False ,
}
string ,
imageTag:
{
Description: The tag to apply to the generated image. ,
Required: False ,
}
string ,
}
,
azurePipelineProfile:
{
Description: Profile of an azure pipeline. ,
Required: False ,
}
{
repository:
{
Description: Details of the ADO repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
adoOrganization:
{
Description: The name of the Azure DevOps organization the pipeline is associated with. ,
Required: False ,
}
string ,
projectName:
{
Description: The name of the project the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
armServiceConnection:
{
Description: The name of the ARM Service Connection the pipeline is associated with. ,
Required: False ,
}
string ,
build:
{
Description: Build details of the repository associated with the workflow. ,
Required: False ,
}
{
dockerfile:
{
Description: Path to the Dockerfile within the repository. ,
Required: False ,
}
string ,
dockerBuildContext:
{
Description: Path to Dockerfile Build Context within the repository. ,
Required: False ,
}
string ,
}
,
deployment:
{
Description: Deployment details of the repository associated with the workflow. ,
Required: False ,
}
{
manifestType:
{
Description: Determines the type of manifests within the repository. ,
Enum:
{
helm: Repositories using helm ,
kube: Repositories using kubernetes manifests ,
kustomize: No description available. ,
}
,
Required: False ,
}
enum ,
kubeManifestLocations:
{
Required: False ,
}
[
string ,
]
,
helmChartPath:
{
Description: Helm chart directory path in repository. ,
Required: False ,
}
string ,
helmValues:
{
Description: Helm Values.yaml file location in repository. ,
Required: False ,
}
string ,
overrides:
{
Description: Manifest override values. ,
Required: False ,
}
object ,
}
,
namespace:
{
Description: Kubernetes namespace the application is deployed to. ,
Required: False ,
}
string ,
acr:
{
Description: Resource identifier for azure container registry repository associated with the workflow. ,
Format: arm-id ,
Required: False ,
}
string ,
clusterId:
{
Description: The Azure Kubernetes Cluster Resource the application will be deployed to. ,
Format: arm-id ,
Required: False ,
}
string ,
pullRequest:
{
Description: Details of the pull request containing the workflow. ,
Required: False ,
}
{
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
}
,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
}
,
templateWorkflowProfile:
{
Description: Profile of an template workflow. ,
Required: False ,
}
{
repositoryProvider:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
github: GitHub repository provider type. ,
ado: ADO repository provider type. ,
}
,
Required: False ,
}
enum ,
workflowTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
deploymentTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
dockerfileTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
manifestTemplates:
{
Required: False ,
}
[
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
]
,
gitHubProviderProfile:
{
Description: Details of the GitHub repository and credentials associated with the workflow. ,
Required: False ,
}
{
repository:
{
Description: Details of the GitHub repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
}
,
oidcCredentials:
{
Description: The fields needed for OIDC with GitHub. ,
Required: False ,
}
{
azureClientId:
{
Description: Azure Application Client ID ,
Required: False ,
}
string ,
azureTenantId:
{
Description: Azure Directory (tenant) ID ,
Required: False ,
}
string ,
}
,
}
,
adoProviderProfile:
{
Description: Details of the GitHub repository associated with the workflow. ,
Required: False ,
}
{
repository:
{
Description: Details of the ADO repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
adoOrganization:
{
Description: The name of the Azure DevOps organization the pipeline is associated with. ,
Required: False ,
}
string ,
projectName:
{
Description: The name of the project the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
armServiceConnection:
{
Description: The name of the ARM Service Connection the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
pullRequest:
{
Description: Details of the pull request containing the workflow. ,
Required: False ,
}
{
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
}
,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of workflow results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: Properties of a workflow. ,
Required: False ,
}
{
githubWorkflowProfile:
{
Description: Profile of a github workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: Repository Owner ,
Required: False ,
}
string ,
repositoryName:
{
Description: Repository Name ,
Required: False ,
}
string ,
branchName:
{
Description: Repository Branch Name ,
Required: False ,
}
string ,
dockerfile:
{
Description: Path to the Dockerfile within the repository. ,
Required: False ,
}
string ,
dockerBuildContext:
{
Description: Path to Dockerfile Build Context within the repository. ,
Required: False ,
}
string ,
deploymentProperties:
{
Description: Deployment details of the repository associated with the workflow. ,
Required: False ,
}
{
manifestType:
{
Description: Determines the type of manifests within the repository. ,
Enum:
{
helm: Repositories using helm ,
kube: Repositories using kubernetes manifests ,
kustomize: No description available. ,
}
,
Required: False ,
}
enum ,
kubeManifestLocations:
{
Required: False ,
}
[
string ,
]
,
helmChartPath:
{
Description: Helm chart directory path in repository. ,
Required: False ,
}
string ,
helmValues:
{
Description: Helm Values.yaml file location in repository. ,
Required: False ,
}
string ,
overrides:
{
Description: Manifest override values. ,
Required: False ,
}
object ,
}
,
namespace:
{
Description: Kubernetes namespace the application is deployed to. ,
Required: False ,
}
string ,
acr:
{
Description: Information on the azure container registry ,
Required: False ,
}
{
acrSubscriptionId:
{
Description: ACR subscription id ,
Required: False ,
}
string ,
acrResourceGroup:
{
Description: ACR resource group ,
Required: False ,
}
string ,
acrRegistryName:
{
Description: ACR registry ,
Required: False ,
}
string ,
acrRepositoryName:
{
Description: ACR repository ,
Required: False ,
}
string ,
}
,
oidcCredentials:
{
Description: The fields needed for OIDC with GitHub. ,
Required: False ,
}
{
azureClientId:
{
Description: Azure Application Client ID ,
Required: False ,
}
string ,
azureTenantId:
{
Description: Azure Directory (tenant) ID ,
Required: False ,
}
string ,
}
,
aksResourceId:
{
Description: The Azure Kubernetes Cluster Resource the application will be deployed to. ,
Required: False ,
}
string ,
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
}
,
artifactGenerationProperties:
{
Description: Properties for generating artifacts like dockerfile and manifests. ,
Required: False ,
}
{
generationLanguage:
{
Description: The programming language used. ,
Enum:
{
clojure: clojure language ,
csharp: csharp language ,
erlang: erlang language ,
go: go language ,
gomodule: gomodule language ,
gradle: gradle language ,
java: java language ,
javascript: javascript language ,
php: php language ,
python: python language ,
ruby: ruby language ,
rust: rust language ,
swift: swift language ,
}
,
Required: False ,
}
enum ,
languageVersion:
{
Description: The version of the language image used for execution in the generated dockerfile. ,
Required: False ,
}
string ,
builderVersion:
{
Description: The version of the language image used for building the code in the generated dockerfile. ,
Required: False ,
}
string ,
port:
{
Description: The port the application is exposed on. ,
Required: False ,
}
string ,
appName:
{
Description: The name of the app. ,
Required: False ,
}
string ,
dockerfileOutputDirectory:
{
Description: The directory to output the generated Dockerfile to. ,
Required: False ,
}
string ,
manifestOutputDirectory:
{
Description: The directory to output the generated manifests to. ,
Required: False ,
}
string ,
dockerfileGenerationMode:
{
Description: The mode of generation to be used for generating Dockerfiles. ,
Enum:
{
enabled: Dockerfiles will be generated ,
disabled: Dockerfiles will not be generated ,
}
,
Required: False ,
}
enum ,
manifestGenerationMode:
{
Description: The mode of generation to be used for generating Manifest. ,
Enum:
{
enabled: Manifests will be generated ,
disabled: Manifests will not be generated ,
}
,
Required: False ,
}
enum ,
manifestType:
{
Description: Determines the type of manifests to be generated. ,
Enum:
{
helm: Helm manifests ,
kube: Kubernetes manifests ,
}
,
Required: False ,
}
enum ,
imageName:
{
Description: The name of the image to be generated. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace to deploy the application to. ,
Required: False ,
}
string ,
imageTag:
{
Description: The tag to apply to the generated image. ,
Required: False ,
}
string ,
}
,
azurePipelineProfile:
{
Description: Profile of an azure pipeline. ,
Required: False ,
}
{
repository:
{
Description: Details of the ADO repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
adoOrganization:
{
Description: The name of the Azure DevOps organization the pipeline is associated with. ,
Required: False ,
}
string ,
projectName:
{
Description: The name of the project the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
armServiceConnection:
{
Description: The name of the ARM Service Connection the pipeline is associated with. ,
Required: False ,
}
string ,
build:
{
Description: Build details of the repository associated with the workflow. ,
Required: False ,
}
{
dockerfile:
{
Description: Path to the Dockerfile within the repository. ,
Required: False ,
}
string ,
dockerBuildContext:
{
Description: Path to Dockerfile Build Context within the repository. ,
Required: False ,
}
string ,
}
,
deployment:
{
Description: Deployment details of the repository associated with the workflow. ,
Required: False ,
}
{
manifestType:
{
Description: Determines the type of manifests within the repository. ,
Enum:
{
helm: Repositories using helm ,
kube: Repositories using kubernetes manifests ,
kustomize: No description available. ,
}
,
Required: False ,
}
enum ,
kubeManifestLocations:
{
Required: False ,
}
[
string ,
]
,
helmChartPath:
{
Description: Helm chart directory path in repository. ,
Required: False ,
}
string ,
helmValues:
{
Description: Helm Values.yaml file location in repository. ,
Required: False ,
}
string ,
overrides:
{
Description: Manifest override values. ,
Required: False ,
}
object ,
}
,
namespace:
{
Description: Kubernetes namespace the application is deployed to. ,
Required: False ,
}
string ,
acr:
{
Description: Resource identifier for azure container registry repository associated with the workflow. ,
Format: arm-id ,
Required: False ,
}
string ,
clusterId:
{
Description: The Azure Kubernetes Cluster Resource the application will be deployed to. ,
Format: arm-id ,
Required: False ,
}
string ,
pullRequest:
{
Description: Details of the pull request containing the workflow. ,
Required: False ,
}
{
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
}
,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
}
,
templateWorkflowProfile:
{
Description: Profile of an template workflow. ,
Required: False ,
}
{
repositoryProvider:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
github: GitHub repository provider type. ,
ado: ADO repository provider type. ,
}
,
Required: False ,
}
enum ,
workflowTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
deploymentTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
dockerfileTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
manifestTemplates:
{
Required: False ,
}
[
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
]
,
gitHubProviderProfile:
{
Description: Details of the GitHub repository and credentials associated with the workflow. ,
Required: False ,
}
{
repository:
{
Description: Details of the GitHub repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
}
,
oidcCredentials:
{
Description: The fields needed for OIDC with GitHub. ,
Required: False ,
}
{
azureClientId:
{
Description: Azure Application Client ID ,
Required: False ,
}
string ,
azureTenantId:
{
Description: Azure Directory (tenant) ID ,
Required: False ,
}
string ,
}
,
}
,
adoProviderProfile:
{
Description: Details of the GitHub repository associated with the workflow. ,
Required: False ,
}
{
repository:
{
Description: Details of the ADO repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
adoOrganization:
{
Description: The name of the Azure DevOps organization the pipeline is associated with. ,
Required: False ,
}
string ,
projectName:
{
Description: The name of the project the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
armServiceConnection:
{
Description: The name of the ARM Service Connection the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
pullRequest:
{
Description: Details of the pull request containing the workflow. ,
Required: False ,
}
{
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
}
,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
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 ,
}
,
]
,
}
,
}
Workflow_CreateOrUpdate (new)
Description :  Creates or updates a workflow
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/workflows/{workflowName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workflowName:
{
Description: The name of the workflow resource. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
properties:
{
Description: Properties of a workflow. ,
Required: False ,
}
{
githubWorkflowProfile:
{
Description: Profile of a github workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: Repository Owner ,
Required: False ,
}
string ,
repositoryName:
{
Description: Repository Name ,
Required: False ,
}
string ,
branchName:
{
Description: Repository Branch Name ,
Required: False ,
}
string ,
dockerfile:
{
Description: Path to the Dockerfile within the repository. ,
Required: False ,
}
string ,
dockerBuildContext:
{
Description: Path to Dockerfile Build Context within the repository. ,
Required: False ,
}
string ,
deploymentProperties:
{
Description: Deployment details of the repository associated with the workflow. ,
Required: False ,
}
{
manifestType:
{
Description: Determines the type of manifests within the repository. ,
Enum:
{
helm: Repositories using helm ,
kube: Repositories using kubernetes manifests ,
kustomize: No description available. ,
}
,
Required: False ,
}
enum ,
kubeManifestLocations:
{
Required: False ,
}
[
string ,
]
,
helmChartPath:
{
Description: Helm chart directory path in repository. ,
Required: False ,
}
string ,
helmValues:
{
Description: Helm Values.yaml file location in repository. ,
Required: False ,
}
string ,
overrides:
{
Description: Manifest override values. ,
Required: False ,
}
object ,
}
,
namespace:
{
Description: Kubernetes namespace the application is deployed to. ,
Required: False ,
}
string ,
acr:
{
Description: Information on the azure container registry ,
Required: False ,
}
{
acrSubscriptionId:
{
Description: ACR subscription id ,
Required: False ,
}
string ,
acrResourceGroup:
{
Description: ACR resource group ,
Required: False ,
}
string ,
acrRegistryName:
{
Description: ACR registry ,
Required: False ,
}
string ,
acrRepositoryName:
{
Description: ACR repository ,
Required: False ,
}
string ,
}
,
oidcCredentials:
{
Description: The fields needed for OIDC with GitHub. ,
Required: False ,
}
{
azureClientId:
{
Description: Azure Application Client ID ,
Required: False ,
}
string ,
azureTenantId:
{
Description: Azure Directory (tenant) ID ,
Required: False ,
}
string ,
}
,
aksResourceId:
{
Description: The Azure Kubernetes Cluster Resource the application will be deployed to. ,
Required: False ,
}
string ,
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
}
,
artifactGenerationProperties:
{
Description: Properties for generating artifacts like dockerfile and manifests. ,
Required: False ,
}
{
generationLanguage:
{
Description: The programming language used. ,
Enum:
{
clojure: clojure language ,
csharp: csharp language ,
erlang: erlang language ,
go: go language ,
gomodule: gomodule language ,
gradle: gradle language ,
java: java language ,
javascript: javascript language ,
php: php language ,
python: python language ,
ruby: ruby language ,
rust: rust language ,
swift: swift language ,
}
,
Required: False ,
}
enum ,
languageVersion:
{
Description: The version of the language image used for execution in the generated dockerfile. ,
Required: False ,
}
string ,
builderVersion:
{
Description: The version of the language image used for building the code in the generated dockerfile. ,
Required: False ,
}
string ,
port:
{
Description: The port the application is exposed on. ,
Required: False ,
}
string ,
appName:
{
Description: The name of the app. ,
Required: False ,
}
string ,
dockerfileOutputDirectory:
{
Description: The directory to output the generated Dockerfile to. ,
Required: False ,
}
string ,
manifestOutputDirectory:
{
Description: The directory to output the generated manifests to. ,
Required: False ,
}
string ,
dockerfileGenerationMode:
{
Description: The mode of generation to be used for generating Dockerfiles. ,
Enum:
{
enabled: Dockerfiles will be generated ,
disabled: Dockerfiles will not be generated ,
}
,
Required: False ,
}
enum ,
manifestGenerationMode:
{
Description: The mode of generation to be used for generating Manifest. ,
Enum:
{
enabled: Manifests will be generated ,
disabled: Manifests will not be generated ,
}
,
Required: False ,
}
enum ,
manifestType:
{
Description: Determines the type of manifests to be generated. ,
Enum:
{
helm: Helm manifests ,
kube: Kubernetes manifests ,
}
,
Required: False ,
}
enum ,
imageName:
{
Description: The name of the image to be generated. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace to deploy the application to. ,
Required: False ,
}
string ,
imageTag:
{
Description: The tag to apply to the generated image. ,
Required: False ,
}
string ,
}
,
azurePipelineProfile:
{
Description: Profile of an azure pipeline. ,
Required: False ,
}
{
repository:
{
Description: Details of the ADO repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
adoOrganization:
{
Description: The name of the Azure DevOps organization the pipeline is associated with. ,
Required: False ,
}
string ,
projectName:
{
Description: The name of the project the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
armServiceConnection:
{
Description: The name of the ARM Service Connection the pipeline is associated with. ,
Required: False ,
}
string ,
build:
{
Description: Build details of the repository associated with the workflow. ,
Required: False ,
}
{
dockerfile:
{
Description: Path to the Dockerfile within the repository. ,
Required: False ,
}
string ,
dockerBuildContext:
{
Description: Path to Dockerfile Build Context within the repository. ,
Required: False ,
}
string ,
}
,
deployment:
{
Description: Deployment details of the repository associated with the workflow. ,
Required: False ,
}
{
manifestType:
{
Description: Determines the type of manifests within the repository. ,
Enum:
{
helm: Repositories using helm ,
kube: Repositories using kubernetes manifests ,
kustomize: No description available. ,
}
,
Required: False ,
}
enum ,
kubeManifestLocations:
{
Required: False ,
}
[
string ,
]
,
helmChartPath:
{
Description: Helm chart directory path in repository. ,
Required: False ,
}
string ,
helmValues:
{
Description: Helm Values.yaml file location in repository. ,
Required: False ,
}
string ,
overrides:
{
Description: Manifest override values. ,
Required: False ,
}
object ,
}
,
namespace:
{
Description: Kubernetes namespace the application is deployed to. ,
Required: False ,
}
string ,
acr:
{
Description: Resource identifier for azure container registry repository associated with the workflow. ,
Format: arm-id ,
Required: False ,
}
string ,
clusterId:
{
Description: The Azure Kubernetes Cluster Resource the application will be deployed to. ,
Format: arm-id ,
Required: False ,
}
string ,
pullRequest:
{
Description: Details of the pull request containing the workflow. ,
Required: False ,
}
{
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
}
,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
}
,
templateWorkflowProfile:
{
Description: Profile of an template workflow. ,
Required: False ,
}
{
repositoryProvider:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
github: GitHub repository provider type. ,
ado: ADO repository provider type. ,
}
,
Required: False ,
}
enum ,
workflowTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
deploymentTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
dockerfileTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
manifestTemplates:
{
Required: False ,
}
[
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
]
,
gitHubProviderProfile:
{
Description: Details of the GitHub repository and credentials associated with the workflow. ,
Required: False ,
}
{
repository:
{
Description: Details of the GitHub repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
}
,
oidcCredentials:
{
Description: The fields needed for OIDC with GitHub. ,
Required: False ,
}
{
azureClientId:
{
Description: Azure Application Client ID ,
Required: False ,
}
string ,
azureTenantId:
{
Description: Azure Directory (tenant) ID ,
Required: False ,
}
string ,
}
,
}
,
adoProviderProfile:
{
Description: Details of the GitHub repository associated with the workflow. ,
Required: False ,
}
{
repository:
{
Description: Details of the ADO repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
adoOrganization:
{
Description: The name of the Azure DevOps organization the pipeline is associated with. ,
Required: False ,
}
string ,
projectName:
{
Description: The name of the project the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
armServiceConnection:
{
Description: The name of the ARM Service Connection the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
pullRequest:
{
Description: Details of the pull request containing the workflow. ,
Required: False ,
}
{
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
}
,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a workflow. ,
Required: False ,
}
{
githubWorkflowProfile:
{
Description: Profile of a github workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: Repository Owner ,
Required: False ,
}
string ,
repositoryName:
{
Description: Repository Name ,
Required: False ,
}
string ,
branchName:
{
Description: Repository Branch Name ,
Required: False ,
}
string ,
dockerfile:
{
Description: Path to the Dockerfile within the repository. ,
Required: False ,
}
string ,
dockerBuildContext:
{
Description: Path to Dockerfile Build Context within the repository. ,
Required: False ,
}
string ,
deploymentProperties:
{
Description: Deployment details of the repository associated with the workflow. ,
Required: False ,
}
{
manifestType:
{
Description: Determines the type of manifests within the repository. ,
Enum:
{
helm: Repositories using helm ,
kube: Repositories using kubernetes manifests ,
kustomize: No description available. ,
}
,
Required: False ,
}
enum ,
kubeManifestLocations:
{
Required: False ,
}
[
string ,
]
,
helmChartPath:
{
Description: Helm chart directory path in repository. ,
Required: False ,
}
string ,
helmValues:
{
Description: Helm Values.yaml file location in repository. ,
Required: False ,
}
string ,
overrides:
{
Description: Manifest override values. ,
Required: False ,
}
object ,
}
,
namespace:
{
Description: Kubernetes namespace the application is deployed to. ,
Required: False ,
}
string ,
acr:
{
Description: Information on the azure container registry ,
Required: False ,
}
{
acrSubscriptionId:
{
Description: ACR subscription id ,
Required: False ,
}
string ,
acrResourceGroup:
{
Description: ACR resource group ,
Required: False ,
}
string ,
acrRegistryName:
{
Description: ACR registry ,
Required: False ,
}
string ,
acrRepositoryName:
{
Description: ACR repository ,
Required: False ,
}
string ,
}
,
oidcCredentials:
{
Description: The fields needed for OIDC with GitHub. ,
Required: False ,
}
{
azureClientId:
{
Description: Azure Application Client ID ,
Required: False ,
}
string ,
azureTenantId:
{
Description: Azure Directory (tenant) ID ,
Required: False ,
}
string ,
}
,
aksResourceId:
{
Description: The Azure Kubernetes Cluster Resource the application will be deployed to. ,
Required: False ,
}
string ,
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
}
,
artifactGenerationProperties:
{
Description: Properties for generating artifacts like dockerfile and manifests. ,
Required: False ,
}
{
generationLanguage:
{
Description: The programming language used. ,
Enum:
{
clojure: clojure language ,
csharp: csharp language ,
erlang: erlang language ,
go: go language ,
gomodule: gomodule language ,
gradle: gradle language ,
java: java language ,
javascript: javascript language ,
php: php language ,
python: python language ,
ruby: ruby language ,
rust: rust language ,
swift: swift language ,
}
,
Required: False ,
}
enum ,
languageVersion:
{
Description: The version of the language image used for execution in the generated dockerfile. ,
Required: False ,
}
string ,
builderVersion:
{
Description: The version of the language image used for building the code in the generated dockerfile. ,
Required: False ,
}
string ,
port:
{
Description: The port the application is exposed on. ,
Required: False ,
}
string ,
appName:
{
Description: The name of the app. ,
Required: False ,
}
string ,
dockerfileOutputDirectory:
{
Description: The directory to output the generated Dockerfile to. ,
Required: False ,
}
string ,
manifestOutputDirectory:
{
Description: The directory to output the generated manifests to. ,
Required: False ,
}
string ,
dockerfileGenerationMode:
{
Description: The mode of generation to be used for generating Dockerfiles. ,
Enum:
{
enabled: Dockerfiles will be generated ,
disabled: Dockerfiles will not be generated ,
}
,
Required: False ,
}
enum ,
manifestGenerationMode:
{
Description: The mode of generation to be used for generating Manifest. ,
Enum:
{
enabled: Manifests will be generated ,
disabled: Manifests will not be generated ,
}
,
Required: False ,
}
enum ,
manifestType:
{
Description: Determines the type of manifests to be generated. ,
Enum:
{
helm: Helm manifests ,
kube: Kubernetes manifests ,
}
,
Required: False ,
}
enum ,
imageName:
{
Description: The name of the image to be generated. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace to deploy the application to. ,
Required: False ,
}
string ,
imageTag:
{
Description: The tag to apply to the generated image. ,
Required: False ,
}
string ,
}
,
azurePipelineProfile:
{
Description: Profile of an azure pipeline. ,
Required: False ,
}
{
repository:
{
Description: Details of the ADO repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
adoOrganization:
{
Description: The name of the Azure DevOps organization the pipeline is associated with. ,
Required: False ,
}
string ,
projectName:
{
Description: The name of the project the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
armServiceConnection:
{
Description: The name of the ARM Service Connection the pipeline is associated with. ,
Required: False ,
}
string ,
build:
{
Description: Build details of the repository associated with the workflow. ,
Required: False ,
}
{
dockerfile:
{
Description: Path to the Dockerfile within the repository. ,
Required: False ,
}
string ,
dockerBuildContext:
{
Description: Path to Dockerfile Build Context within the repository. ,
Required: False ,
}
string ,
}
,
deployment:
{
Description: Deployment details of the repository associated with the workflow. ,
Required: False ,
}
{
manifestType:
{
Description: Determines the type of manifests within the repository. ,
Enum:
{
helm: Repositories using helm ,
kube: Repositories using kubernetes manifests ,
kustomize: No description available. ,
}
,
Required: False ,
}
enum ,
kubeManifestLocations:
{
Required: False ,
}
[
string ,
]
,
helmChartPath:
{
Description: Helm chart directory path in repository. ,
Required: False ,
}
string ,
helmValues:
{
Description: Helm Values.yaml file location in repository. ,
Required: False ,
}
string ,
overrides:
{
Description: Manifest override values. ,
Required: False ,
}
object ,
}
,
namespace:
{
Description: Kubernetes namespace the application is deployed to. ,
Required: False ,
}
string ,
acr:
{
Description: Resource identifier for azure container registry repository associated with the workflow. ,
Format: arm-id ,
Required: False ,
}
string ,
clusterId:
{
Description: The Azure Kubernetes Cluster Resource the application will be deployed to. ,
Format: arm-id ,
Required: False ,
}
string ,
pullRequest:
{
Description: Details of the pull request containing the workflow. ,
Required: False ,
}
{
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
}
,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
}
,
templateWorkflowProfile:
{
Description: Profile of an template workflow. ,
Required: False ,
}
{
repositoryProvider:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
github: GitHub repository provider type. ,
ado: ADO repository provider type. ,
}
,
Required: False ,
}
enum ,
workflowTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
deploymentTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
dockerfileTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
manifestTemplates:
{
Required: False ,
}
[
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
]
,
gitHubProviderProfile:
{
Description: Details of the GitHub repository and credentials associated with the workflow. ,
Required: False ,
}
{
repository:
{
Description: Details of the GitHub repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
}
,
oidcCredentials:
{
Description: The fields needed for OIDC with GitHub. ,
Required: False ,
}
{
azureClientId:
{
Description: Azure Application Client ID ,
Required: False ,
}
string ,
azureTenantId:
{
Description: Azure Directory (tenant) ID ,
Required: False ,
}
string ,
}
,
}
,
adoProviderProfile:
{
Description: Details of the GitHub repository associated with the workflow. ,
Required: False ,
}
{
repository:
{
Description: Details of the ADO repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
adoOrganization:
{
Description: The name of the Azure DevOps organization the pipeline is associated with. ,
Required: False ,
}
string ,
projectName:
{
Description: The name of the project the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
armServiceConnection:
{
Description: The name of the ARM Service Connection the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
pullRequest:
{
Description: Details of the pull request containing the workflow. ,
Required: False ,
}
{
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
}
,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of a workflow. ,
Required: False ,
}
{
githubWorkflowProfile:
{
Description: Profile of a github workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: Repository Owner ,
Required: False ,
}
string ,
repositoryName:
{
Description: Repository Name ,
Required: False ,
}
string ,
branchName:
{
Description: Repository Branch Name ,
Required: False ,
}
string ,
dockerfile:
{
Description: Path to the Dockerfile within the repository. ,
Required: False ,
}
string ,
dockerBuildContext:
{
Description: Path to Dockerfile Build Context within the repository. ,
Required: False ,
}
string ,
deploymentProperties:
{
Description: Deployment details of the repository associated with the workflow. ,
Required: False ,
}
{
manifestType:
{
Description: Determines the type of manifests within the repository. ,
Enum:
{
helm: Repositories using helm ,
kube: Repositories using kubernetes manifests ,
kustomize: No description available. ,
}
,
Required: False ,
}
enum ,
kubeManifestLocations:
{
Required: False ,
}
[
string ,
]
,
helmChartPath:
{
Description: Helm chart directory path in repository. ,
Required: False ,
}
string ,
helmValues:
{
Description: Helm Values.yaml file location in repository. ,
Required: False ,
}
string ,
overrides:
{
Description: Manifest override values. ,
Required: False ,
}
object ,
}
,
namespace:
{
Description: Kubernetes namespace the application is deployed to. ,
Required: False ,
}
string ,
acr:
{
Description: Information on the azure container registry ,
Required: False ,
}
{
acrSubscriptionId:
{
Description: ACR subscription id ,
Required: False ,
}
string ,
acrResourceGroup:
{
Description: ACR resource group ,
Required: False ,
}
string ,
acrRegistryName:
{
Description: ACR registry ,
Required: False ,
}
string ,
acrRepositoryName:
{
Description: ACR repository ,
Required: False ,
}
string ,
}
,
oidcCredentials:
{
Description: The fields needed for OIDC with GitHub. ,
Required: False ,
}
{
azureClientId:
{
Description: Azure Application Client ID ,
Required: False ,
}
string ,
azureTenantId:
{
Description: Azure Directory (tenant) ID ,
Required: False ,
}
string ,
}
,
aksResourceId:
{
Description: The Azure Kubernetes Cluster Resource the application will be deployed to. ,
Required: False ,
}
string ,
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
}
,
artifactGenerationProperties:
{
Description: Properties for generating artifacts like dockerfile and manifests. ,
Required: False ,
}
{
generationLanguage:
{
Description: The programming language used. ,
Enum:
{
clojure: clojure language ,
csharp: csharp language ,
erlang: erlang language ,
go: go language ,
gomodule: gomodule language ,
gradle: gradle language ,
java: java language ,
javascript: javascript language ,
php: php language ,
python: python language ,
ruby: ruby language ,
rust: rust language ,
swift: swift language ,
}
,
Required: False ,
}
enum ,
languageVersion:
{
Description: The version of the language image used for execution in the generated dockerfile. ,
Required: False ,
}
string ,
builderVersion:
{
Description: The version of the language image used for building the code in the generated dockerfile. ,
Required: False ,
}
string ,
port:
{
Description: The port the application is exposed on. ,
Required: False ,
}
string ,
appName:
{
Description: The name of the app. ,
Required: False ,
}
string ,
dockerfileOutputDirectory:
{
Description: The directory to output the generated Dockerfile to. ,
Required: False ,
}
string ,
manifestOutputDirectory:
{
Description: The directory to output the generated manifests to. ,
Required: False ,
}
string ,
dockerfileGenerationMode:
{
Description: The mode of generation to be used for generating Dockerfiles. ,
Enum:
{
enabled: Dockerfiles will be generated ,
disabled: Dockerfiles will not be generated ,
}
,
Required: False ,
}
enum ,
manifestGenerationMode:
{
Description: The mode of generation to be used for generating Manifest. ,
Enum:
{
enabled: Manifests will be generated ,
disabled: Manifests will not be generated ,
}
,
Required: False ,
}
enum ,
manifestType:
{
Description: Determines the type of manifests to be generated. ,
Enum:
{
helm: Helm manifests ,
kube: Kubernetes manifests ,
}
,
Required: False ,
}
enum ,
imageName:
{
Description: The name of the image to be generated. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace to deploy the application to. ,
Required: False ,
}
string ,
imageTag:
{
Description: The tag to apply to the generated image. ,
Required: False ,
}
string ,
}
,
azurePipelineProfile:
{
Description: Profile of an azure pipeline. ,
Required: False ,
}
{
repository:
{
Description: Details of the ADO repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
adoOrganization:
{
Description: The name of the Azure DevOps organization the pipeline is associated with. ,
Required: False ,
}
string ,
projectName:
{
Description: The name of the project the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
armServiceConnection:
{
Description: The name of the ARM Service Connection the pipeline is associated with. ,
Required: False ,
}
string ,
build:
{
Description: Build details of the repository associated with the workflow. ,
Required: False ,
}
{
dockerfile:
{
Description: Path to the Dockerfile within the repository. ,
Required: False ,
}
string ,
dockerBuildContext:
{
Description: Path to Dockerfile Build Context within the repository. ,
Required: False ,
}
string ,
}
,
deployment:
{
Description: Deployment details of the repository associated with the workflow. ,
Required: False ,
}
{
manifestType:
{
Description: Determines the type of manifests within the repository. ,
Enum:
{
helm: Repositories using helm ,
kube: Repositories using kubernetes manifests ,
kustomize: No description available. ,
}
,
Required: False ,
}
enum ,
kubeManifestLocations:
{
Required: False ,
}
[
string ,
]
,
helmChartPath:
{
Description: Helm chart directory path in repository. ,
Required: False ,
}
string ,
helmValues:
{
Description: Helm Values.yaml file location in repository. ,
Required: False ,
}
string ,
overrides:
{
Description: Manifest override values. ,
Required: False ,
}
object ,
}
,
namespace:
{
Description: Kubernetes namespace the application is deployed to. ,
Required: False ,
}
string ,
acr:
{
Description: Resource identifier for azure container registry repository associated with the workflow. ,
Format: arm-id ,
Required: False ,
}
string ,
clusterId:
{
Description: The Azure Kubernetes Cluster Resource the application will be deployed to. ,
Format: arm-id ,
Required: False ,
}
string ,
pullRequest:
{
Description: Details of the pull request containing the workflow. ,
Required: False ,
}
{
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
}
,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
}
,
templateWorkflowProfile:
{
Description: Profile of an template workflow. ,
Required: False ,
}
{
repositoryProvider:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
github: GitHub repository provider type. ,
ado: ADO repository provider type. ,
}
,
Required: False ,
}
enum ,
workflowTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
deploymentTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
dockerfileTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
manifestTemplates:
{
Required: False ,
}
[
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
]
,
gitHubProviderProfile:
{
Description: Details of the GitHub repository and credentials associated with the workflow. ,
Required: False ,
}
{
repository:
{
Description: Details of the GitHub repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
}
,
oidcCredentials:
{
Description: The fields needed for OIDC with GitHub. ,
Required: False ,
}
{
azureClientId:
{
Description: Azure Application Client ID ,
Required: False ,
}
string ,
azureTenantId:
{
Description: Azure Directory (tenant) ID ,
Required: False ,
}
string ,
}
,
}
,
adoProviderProfile:
{
Description: Details of the GitHub repository associated with the workflow. ,
Required: False ,
}
{
repository:
{
Description: Details of the ADO repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
adoOrganization:
{
Description: The name of the Azure DevOps organization the pipeline is associated with. ,
Required: False ,
}
string ,
projectName:
{
Description: The name of the project the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
armServiceConnection:
{
Description: The name of the ARM Service Connection the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
pullRequest:
{
Description: Details of the pull request containing the workflow. ,
Required: False ,
}
{
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
}
,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
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 ,
}
,
]
,
}
,
}
Workflow_Delete (new)
Description :  Deletes a workflow
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
status:
{
Description: delete status message ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Workflow_UpdateTags (new)
Description :  Updates tags on a workflow.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/workflows/{workflowName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workflowName:
{
Description: The name of the workflow resource. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update Workflow Tags operation. ,
Required: True ,
}
{
tags:
{
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of a workflow. ,
Required: False ,
}
{
githubWorkflowProfile:
{
Description: Profile of a github workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: Repository Owner ,
Required: False ,
}
string ,
repositoryName:
{
Description: Repository Name ,
Required: False ,
}
string ,
branchName:
{
Description: Repository Branch Name ,
Required: False ,
}
string ,
dockerfile:
{
Description: Path to the Dockerfile within the repository. ,
Required: False ,
}
string ,
dockerBuildContext:
{
Description: Path to Dockerfile Build Context within the repository. ,
Required: False ,
}
string ,
deploymentProperties:
{
Description: Deployment details of the repository associated with the workflow. ,
Required: False ,
}
{
manifestType:
{
Description: Determines the type of manifests within the repository. ,
Enum:
{
helm: Repositories using helm ,
kube: Repositories using kubernetes manifests ,
kustomize: No description available. ,
}
,
Required: False ,
}
enum ,
kubeManifestLocations:
{
Required: False ,
}
[
string ,
]
,
helmChartPath:
{
Description: Helm chart directory path in repository. ,
Required: False ,
}
string ,
helmValues:
{
Description: Helm Values.yaml file location in repository. ,
Required: False ,
}
string ,
overrides:
{
Description: Manifest override values. ,
Required: False ,
}
object ,
}
,
namespace:
{
Description: Kubernetes namespace the application is deployed to. ,
Required: False ,
}
string ,
acr:
{
Description: Information on the azure container registry ,
Required: False ,
}
{
acrSubscriptionId:
{
Description: ACR subscription id ,
Required: False ,
}
string ,
acrResourceGroup:
{
Description: ACR resource group ,
Required: False ,
}
string ,
acrRegistryName:
{
Description: ACR registry ,
Required: False ,
}
string ,
acrRepositoryName:
{
Description: ACR repository ,
Required: False ,
}
string ,
}
,
oidcCredentials:
{
Description: The fields needed for OIDC with GitHub. ,
Required: False ,
}
{
azureClientId:
{
Description: Azure Application Client ID ,
Required: False ,
}
string ,
azureTenantId:
{
Description: Azure Directory (tenant) ID ,
Required: False ,
}
string ,
}
,
aksResourceId:
{
Description: The Azure Kubernetes Cluster Resource the application will be deployed to. ,
Required: False ,
}
string ,
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
}
,
artifactGenerationProperties:
{
Description: Properties for generating artifacts like dockerfile and manifests. ,
Required: False ,
}
{
generationLanguage:
{
Description: The programming language used. ,
Enum:
{
clojure: clojure language ,
csharp: csharp language ,
erlang: erlang language ,
go: go language ,
gomodule: gomodule language ,
gradle: gradle language ,
java: java language ,
javascript: javascript language ,
php: php language ,
python: python language ,
ruby: ruby language ,
rust: rust language ,
swift: swift language ,
}
,
Required: False ,
}
enum ,
languageVersion:
{
Description: The version of the language image used for execution in the generated dockerfile. ,
Required: False ,
}
string ,
builderVersion:
{
Description: The version of the language image used for building the code in the generated dockerfile. ,
Required: False ,
}
string ,
port:
{
Description: The port the application is exposed on. ,
Required: False ,
}
string ,
appName:
{
Description: The name of the app. ,
Required: False ,
}
string ,
dockerfileOutputDirectory:
{
Description: The directory to output the generated Dockerfile to. ,
Required: False ,
}
string ,
manifestOutputDirectory:
{
Description: The directory to output the generated manifests to. ,
Required: False ,
}
string ,
dockerfileGenerationMode:
{
Description: The mode of generation to be used for generating Dockerfiles. ,
Enum:
{
enabled: Dockerfiles will be generated ,
disabled: Dockerfiles will not be generated ,
}
,
Required: False ,
}
enum ,
manifestGenerationMode:
{
Description: The mode of generation to be used for generating Manifest. ,
Enum:
{
enabled: Manifests will be generated ,
disabled: Manifests will not be generated ,
}
,
Required: False ,
}
enum ,
manifestType:
{
Description: Determines the type of manifests to be generated. ,
Enum:
{
helm: Helm manifests ,
kube: Kubernetes manifests ,
}
,
Required: False ,
}
enum ,
imageName:
{
Description: The name of the image to be generated. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace to deploy the application to. ,
Required: False ,
}
string ,
imageTag:
{
Description: The tag to apply to the generated image. ,
Required: False ,
}
string ,
}
,
azurePipelineProfile:
{
Description: Profile of an azure pipeline. ,
Required: False ,
}
{
repository:
{
Description: Details of the ADO repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
adoOrganization:
{
Description: The name of the Azure DevOps organization the pipeline is associated with. ,
Required: False ,
}
string ,
projectName:
{
Description: The name of the project the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
armServiceConnection:
{
Description: The name of the ARM Service Connection the pipeline is associated with. ,
Required: False ,
}
string ,
build:
{
Description: Build details of the repository associated with the workflow. ,
Required: False ,
}
{
dockerfile:
{
Description: Path to the Dockerfile within the repository. ,
Required: False ,
}
string ,
dockerBuildContext:
{
Description: Path to Dockerfile Build Context within the repository. ,
Required: False ,
}
string ,
}
,
deployment:
{
Description: Deployment details of the repository associated with the workflow. ,
Required: False ,
}
{
manifestType:
{
Description: Determines the type of manifests within the repository. ,
Enum:
{
helm: Repositories using helm ,
kube: Repositories using kubernetes manifests ,
kustomize: No description available. ,
}
,
Required: False ,
}
enum ,
kubeManifestLocations:
{
Required: False ,
}
[
string ,
]
,
helmChartPath:
{
Description: Helm chart directory path in repository. ,
Required: False ,
}
string ,
helmValues:
{
Description: Helm Values.yaml file location in repository. ,
Required: False ,
}
string ,
overrides:
{
Description: Manifest override values. ,
Required: False ,
}
object ,
}
,
namespace:
{
Description: Kubernetes namespace the application is deployed to. ,
Required: False ,
}
string ,
acr:
{
Description: Resource identifier for azure container registry repository associated with the workflow. ,
Format: arm-id ,
Required: False ,
}
string ,
clusterId:
{
Description: The Azure Kubernetes Cluster Resource the application will be deployed to. ,
Format: arm-id ,
Required: False ,
}
string ,
pullRequest:
{
Description: Details of the pull request containing the workflow. ,
Required: False ,
}
{
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
}
,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
Required: False ,
}
enum ,
}
,
templateWorkflowProfile:
{
Description: Profile of an template workflow. ,
Required: False ,
}
{
repositoryProvider:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
github: GitHub repository provider type. ,
ado: ADO repository provider type. ,
}
,
Required: False ,
}
enum ,
workflowTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
deploymentTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
dockerfileTemplate:
{
Description: The properties of ADO OAuth. ,
Required: False ,
}
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
manifestTemplates:
{
Required: False ,
}
[
{
templateId:
{
Description: The versioned template arm resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
destination:
{
Description: destination for template creation ,
Required: False ,
}
string ,
parameters:
{
Description: parameters for template creation ,
Required: False ,
}
object ,
}
,
]
,
gitHubProviderProfile:
{
Description: Details of the GitHub repository and credentials associated with the workflow. ,
Required: False ,
}
{
repository:
{
Description: Details of the GitHub repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
}
,
oidcCredentials:
{
Description: The fields needed for OIDC with GitHub. ,
Required: False ,
}
{
azureClientId:
{
Description: Azure Application Client ID ,
Required: False ,
}
string ,
azureTenantId:
{
Description: Azure Directory (tenant) ID ,
Required: False ,
}
string ,
}
,
}
,
adoProviderProfile:
{
Description: Details of the GitHub repository associated with the workflow. ,
Required: False ,
}
{
repository:
{
Description: Details of the ADO repository associated with the workflow. ,
Required: False ,
}
{
repositoryOwner:
{
Description: The owner of the repository the workflow is associated with. ,
Required: False ,
}
string ,
repositoryName:
{
Description: The name of the repository the workflow is associated with. ,
Required: False ,
}
string ,
branchName:
{
Description: The name of the branch the workflow is associated with. ,
Required: False ,
}
string ,
adoOrganization:
{
Description: The name of the Azure DevOps organization the pipeline is associated with. ,
Required: False ,
}
string ,
projectName:
{
Description: The name of the project the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
armServiceConnection:
{
Description: The name of the ARM Service Connection the pipeline is associated with. ,
Required: False ,
}
string ,
}
,
pullRequest:
{
Description: Details of the pull request containing the workflow. ,
Required: False ,
}
{
prURL:
{
Description: The URL to the Pull Request submitted against the users repository. ,
Required: False ,
}
string ,
pullNumber:
{
Description: The number associated with the submitted pull request. ,
Format: int32 ,
Required: False ,
}
integer ,
prStatus:
{
Description: The status of the Pull Request submitted against the users repository. ,
Enum:
{
unknown: Pull Request state unknown. ,
submitted: Pull Request submitted to repository. ,
merged: Pull Request merged into repository. ,
removed: Workflow no longer found within repository. ,
}
,
Required: False ,
}
enum ,
}
,
lastWorkflowRun:
{
Required: False ,
}
{
succeeded:
{
Description: Describes if the workflow run succeeded. ,
Required: False ,
}
boolean ,
workflowRunURL:
{
Description: URL to the run of the workflow. ,
Required: False ,
}
string ,
lastRunAt:
{
Description: The timestamp of the last workflow run. ,
Format: date-time ,
Required: False ,
}
string ,
workflowRunStatus:
{
Description: Describes the status of the workflow run ,
Enum:
{
queued: Workflow run is queued ,
inprogress: Workflow run is inprogress ,
completed: Workflow run is completed ,
}
,
Required: False ,
}
enum ,
}
,
authStatus:
{
Description: Determines the authorization status of requests. ,
Enum:
{
Authorized: Requests authorized successfully ,
NotFound: Requests returned NotFound response ,
Error: Requests returned other error response ,
}
,
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 ,
}
,
]
,
}
,
}
GeneratePreviewArtifacts (new)
Description :  Generate preview dockerfile and manifests.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/generatePreviewArtifacts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
generationLanguage:
{
Description: The programming language used. ,
Enum:
{
clojure: clojure language ,
csharp: csharp language ,
erlang: erlang language ,
go: go language ,
gomodule: gomodule language ,
gradle: gradle language ,
java: java language ,
javascript: javascript language ,
php: php language ,
python: python language ,
ruby: ruby language ,
rust: rust language ,
swift: swift language ,
}
,
Required: False ,
}
enum ,
languageVersion:
{
Description: The version of the language image used for execution in the generated dockerfile. ,
Required: False ,
}
string ,
builderVersion:
{
Description: The version of the language image used for building the code in the generated dockerfile. ,
Required: False ,
}
string ,
port:
{
Description: The port the application is exposed on. ,
Required: False ,
}
string ,
appName:
{
Description: The name of the app. ,
Required: False ,
}
string ,
dockerfileOutputDirectory:
{
Description: The directory to output the generated Dockerfile to. ,
Required: False ,
}
string ,
manifestOutputDirectory:
{
Description: The directory to output the generated manifests to. ,
Required: False ,
}
string ,
dockerfileGenerationMode:
{
Description: The mode of generation to be used for generating Dockerfiles. ,
Enum:
{
enabled: Dockerfiles will be generated ,
disabled: Dockerfiles will not be generated ,
}
,
Required: False ,
}
enum ,
manifestGenerationMode:
{
Description: The mode of generation to be used for generating Manifest. ,
Enum:
{
enabled: Manifests will be generated ,
disabled: Manifests will not be generated ,
}
,
Required: False ,
}
enum ,
manifestType:
{
Description: Determines the type of manifests to be generated. ,
Enum:
{
helm: Helm manifests ,
kube: Kubernetes manifests ,
}
,
Required: False ,
}
enum ,
imageName:
{
Description: The name of the image to be generated. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace to deploy the application to. ,
Required: False ,
}
string ,
imageTag:
{
Description: The tag to apply to the generated image. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$schema:
{
Description: Dockerfile and manifest artifacts generated as a preview are returned as a map ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GetADOOAuthInfo (new)
Description :  Gets ADOOAuth info used to authenticate users with ADO.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/adooauth/default/getADOOAuthInfo
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
parameters:
{
Description: The fields required in ADO OAuth call request. ,
Required: False ,
}
{
redirectUrl:
{
Description: The URL the client will redirect to on successful authentication. If empty, no redirect will occur. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
authURL:
{
Description: URL used to authorize ADO app using Entra ID ,
Required: False ,
}
string ,
token:
{
Description: OAuth token used to make calls to ADO APIs ,
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 ,
}
,
]
,
}
,
}
ADOOAuth_Get (new)
Description :  Callback URL to hit once authenticated with Entra ID to have the service store the OAuth token.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/adooauth/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of ADO OAuth. ,
Required: False ,
}
{
username:
{
Description: user making request ,
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 ,
}
,
]
,
}
,
}
ADOOAuth_List (new)
Description :  Callback URL to hit once authenticated with ADO to have the service store the OAuth token.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: Singleton list response containing one ADOOAuthResponse ,
Required: False ,
}
[
{
properties:
{
Description: Details of ADO OAuth. ,
Required: False ,
}
{
username:
{
Description: user making request ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to the next set of ADO OAuth results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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