openapi-directory/api/azure.com/automation-sourceControl.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"title":"AutomationManagement","version":"2017-05-15-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControl.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"automation-sourceControl","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls":{"get":{"description":"Retrieve a list of source controls.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/sourcecontroloperations"},"operationId":"SourceControl_ListByAutomationAccount","parameters":[{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"List sourceControls":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"List sourceControls":{"value":"sampleAccount9"}}},{"description":"The filter to apply on the operation.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List sourceControls":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List sourceControls":{"value":"2017-05-15-preview"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceControlListResult"},"examples":{"List sourceControls":{"$ref":"#/components/examples/List_sourceControls"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["SourceControl"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}":{"delete":{"description":"Delete the source control.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/sourcecontroloperations"},"operationId":"SourceControl_Delete","parameters":[{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Delete a source control":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Delete a source control":{"value":"sampleAccount9"}}},{"description":"The name of source control.","in":"path","name":"sourceControlName","required":true,"schema":{"type":"string"},"examples":{"Delete a source control":{"value":"sampleSourceControl"}}},{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Delete a source control":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete a source control":{"value":"2017-05-15-preview"}}}],"responses":{"200":{"description":"OK"},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["SourceControl"]},"get":{"description":"Retrieve the source control identified by source control name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/sourcecontroloperations"},"operationId":"SourceControl_Get","parameters":[{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Get a source control":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get a source control":{"value":"sampleAccount9"}}},{"description":"The name of source control.","in":"path","name":"sourceControlName","required":true,"schema":{"type":"string"},"examples":{"Get a source control":{"value":"sampleSourceControl"}}},{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get a source control":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get a source control":{"value":"2017-05-15-preview"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceControl"},"examples":{"Get a source control":{"$ref":"#/components/examples/Get_a_source_control"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["SourceControl"]},"patch":{"description":"Update a source control.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/sourcecontroloperations"},"operationId":"SourceControl_Update","parameters":[{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Update a source control":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Update a source control":{"value":"sampleAccount9"}}},{"description":"The source control name.","in":"path","name":"sourceControlName","required":true,"schema":{"type":"string"},"examples":{"Update a source control":{"value":"sampleSourceControl"}}},{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Update a source control":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Update a source control":{"value":"2017-05-15-preview"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceControlUpdateParameters"}}},"description":"The parameters supplied to the update source control operation.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceControl"},"examples":{"Update a source control":{"$ref":"#/components/examples/Update_a_source_control"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["SourceControl"]},"put":{"description":"Create a source control.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/sourcecontroloperations"},"operationId":"SourceControl_CreateOrUpdate","parameters":[{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Create or update a source control":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Create or update a source control":{"value":"sampleAccount9"}}},{"description":"The source control name.","in":"path","name":"sourceControlName","required":true,"schema":{"type":"string"},"examples":{"Create or update a source control":{"value":"sampleSourceControl"}}},{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Create or update a source control":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create or update a source control":{"value":"2017-05-15-preview"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceControlCreateOrUpdateParameters"}}},"description":"The parameters supplied to the create or update source control operation.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceControl"},"examples":{"Create or update a source control":{"$ref":"#/components/examples/Create_or_update_a_source_control"}}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceControl"},"examples":{"Create or update a source control":{"$ref":"#/components/examples/Create_or_update_a_source_control"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["SourceControl"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_sourceControls":{"value":{"value":[{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/sampleAccount9/sourcecontrols/sampleSourceControl1","name":"sampleSourceControl1","properties":{"autoSync":true,"branch":"master","creationTime":"2017-03-28T22:59:00.937+00:00","description":"my description","folderPath":"/sampleFolder/sampleFolder2","lastModifiedTime":"2017-03-28T22:59:00.937+00:00","publishRunbook":true,"repoUrl":"https://github.com/SampleUserRepro/PowerShell-1","sourceType":"GitHub"}},{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/sampleAccount9/sourcecontrols/sampleSourceControl2","name":"sampleSourceControl2","properties":{"autoSync":true,"branch":"master","creationTime":"2017-03-28T22:59:00.937+00:00","description":"my description","folderPath":"/sampleFolder/sampleFolder2","lastModifiedTime":"2017-03-28T22:59:00.937+00:00","publishRunbook":true,"repoUrl":"https://github.com/SampleUserRepro/PowerShell-2","sourceType":"GitHub"}},{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/sampleAccount9/sourcecontrols/sampleSourceControl3","name":"sampleSourceControl3","properties":{"autoSync":true,"branch":"master","creationTime":"2017-03-28T22:59:00.937+00:00","description":"my description","folderPath":"/sampleFolder/sampleFolder2","lastModifiedTime":"2017-03-28T22:59:00.937+00:00","publishRunbook":true,"repoUrl":"https://github.com/SampleUserRepro/PowerShell-3","sourceType":"GitHub"}},{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/sampleAccount9/sourcecontrols/sampleSourceControl4","name":"sampleSourceControl4","properties":{"autoSync":true,"branch":"master","creationTime":"2017-03-28T22:59:00.937+00:00","description":"my description","folderPath":"/sampleFolder/sampleFolder2","lastModifiedTime":"2017-03-28T22:59:00.937+00:00","publishRunbook":true,"repoUrl":"https://github.com/SampleUserRepro/PowerShell-4","sourceType":"GitHub"}},{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/sampleAccount9/sourcecontrols/sampleSourceControl5","name":"sampleSourceControl5","properties":{"autoSync":true,"branch":"master","creationTime":"2017-03-28T22:59:00.937+00:00","description":"my description","folderPath":"/sampleFolder/sampleFolder2","lastModifiedTime":"2017-03-28T22:59:00.937+00:00","publishRunbook":true,"repoUrl":"https://github.com/SampleUserRepro/PowerShell-5","sourceType":"GitHub"}}]}},"Get_a_source_control":{"value":{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/sampleAccount9/sourcecontrols/sampleSourceControl","name":"sampleSourceControl","properties":{"autoSync":true,"branch":"master","creationTime":"2017-03-28T22:59:00.937+00:00","description":"my description","folderPath":"/folderOne/folderTwo","lastModifiedTime":"2017-03-28T22:59:00.937+00:00","publishRunbook":true,"repoUrl":"https://github.com/SampleUserRepro/PowerShell","sourceType":"GitHub"}}},"Update_a_source_control":{"value":{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/sampleAccount9/sourcecontrols/sampleSourceControl","name":"sampleSourceControl","properties":{"autoSync":true,"branch":"master","creationTime":"2017-03-28T22:59:00.937+00:00","description":"my description","folderPath":"/folderOne/folderTwo","lastModifiedTime":"2017-03-28T22:59:00.937+00:00","publishRunbook":true,"repoUrl":"https://sampleUser.visualstudio.com/myProject/_git/myRepository","sourceType":"VsoGit"}}},"Create_or_update_a_source_control":{"value":{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/sampleAccount9/sourcecontrols/sampleSourceControl","name":"sampleSourceControl","properties":{"autoSync":true,"branch":"master","creationTime":"2017-03-28T22:59:00.937+00:00","description":"my description","folderPath":"/folderOne/folderTwo","lastModifiedTime":"2017-03-28T22:59:00.937+00:00","publishRunbook":true,"repoUrl":"https://sampleUser.visualstudio.com/myProject/_git/myRepository","sourceType":"VsoGit"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"SourceControl":{"allOf":[{"allOf":[{"description":"The core properties of ARM resources","properties":{"id":{"description":"Fully qualified resource Id for the resource","readOnly":true,"type":"string"},"name":{"description":"The name of the resource","readOnly":true,"type":"string"},"type":{"description":"The type of the resource.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"ARM proxy resource.","properties":{},"type":"object"}],"description":"Definition of the source control.","properties":{"properties":{"$ref":"#/components/schemas/SourceControlProperties"}}},"SourceControlCreateOrUpdateParameters":{"description":"The parameters supplied to the create or update source control operation.","properties":{"properties":{"$ref":"#/components/schemas/SourceControlCreateOrUpdateProperties"}},"required":["properties"]},"SourceControlCreateOrUpdateProperties":{"description":"The properties of the create source control operation.","properties":{"autoSync":{"description":"The auto async of the source control. Default is false.","type":"boolean"},"branch":{"description":"The repo branch of the source control. Include branch as empty string for VsoTfvc.","maxLength":255,"type":"string"},"description":{"description":"The user description of the source control.","maxLength":512,"type":"string"},"folderPath":{"description":"The folder path of the source control. Path must be relative.","maxLength":255,"type":"string"},"publishRunbook":{"description":"The auto publish of the source control. Default is true.","type":"boolean"},"repoUrl":{"description":"The repo url of the source control.","maxLength":2000,"type":"string"},"securityToken":{"$ref":"#/components/schemas/SourceControlSecurityTokenProperties"},"sourceType":{"description":"The source type. Must be one of VsoGit, VsoTfvc, GitHub, case sensitive.","enum":["VsoGit","VsoTfvc","GitHub"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"sourceType"}}}},"SourceControlListResult":{"description":"The response model for the list source controls operation.","properties":{"nextLink":{"description":"The next link.","type":"string"},"value":{"description":"The list of source controls.","items":{"$ref":"#/components/schemas/SourceControl"},"type":"array"}}},"SourceControlProperties":{"description":"Definition of the source control properties","properties":{"autoSync":{"description":"The auto sync of the source control. Default is false.","type":"boolean"},"branch":{"description":"The repo branch of the source control. Include branch as empty string for VsoTfvc.","type":"string"},"creationTime":{"description":"The creation time.","format":"date-time","type":"string","nullable":false},"description":{"description":"The description.","type":"string"},"folderPath":{"description":"The folder path of the source control.","type":"string"},"lastModifiedTime":{"description":"The last modified time.","format":"date-time","type":"string","nullable":false},"publishRunbook":{"description":"The auto publish of the source control. Default is true.","type":"boolean"},"repoUrl":{"description":"The repo url of the source control.","type":"string"},"sourceType":{"description":"The source type. Must be one of VsoGit, VsoTfvc, GitHub.","enum":["VsoGit","VsoTfvc","GitHub"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"sourceType"}}}},"SourceControlSecurityTokenProperties":{"properties":{"accessToken":{"description":"The access token.","maxLength":1024,"type":"string"},"refreshToken":{"description":"The refresh token.","maxLength":1024,"type":"string"},"tokenType":{"description":"The token type. Must be either PersonalAccessToken or Oauth.","enum":["PersonalAccessToken","Oauth"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"tokenType"}}}},"SourceControlUpdateParameters":{"description":"The parameters supplied to the update source control operation.","properties":{"properties":{"$ref":"#/components/schemas/SourceControlUpdateProperties"}}},"SourceControlUpdateProperties":{"description":"The properties of the update source control","properties":{"autoSync":{"description":"The auto sync of the source control. Default is false.","type":"boolean"},"branch":{"description":"The repo branch of the source control.","type":"string"},"description":{"description":"The user description of the source control.","type":"string"},"folderPath":{"description":"The folder path of the source control. Path must be relative.","type":"string"},"publishRunbook":{"description":"The auto publish of the source control. Default is true.","type":"boolean"},"securityToken":{"$ref":"#/components/schemas/SourceControlSecurityTokenProperties"}}}}}}