swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector DeploymentScripts API
schemes:
- https
tags:
- name: DeploymentScripts
paths:
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}
  : put:
      tags:
      - DeploymentScripts
      operationId: microsoftAzureDeploymentscriptsCreate
      x-ms-long-running-operation: true
      description: Creates a deployment script.
      x-ms-examples:
        DeploymentScriptsCreate:
          $ref: ./examples/DeploymentScripts_Create.json
        DeploymentScriptsCreate_MinCreate:
          $ref: ./examples/DeploymentScripts_Min_Create.json
        DeploymentScriptsCreate_UsingCustomACIName:
          $ref: ./examples/DeploymentScripts_Create_Using_Custom_Aci_Name.json
        DeploymentScriptsCreate_UsingExistingStorageAccount:
          $ref: ./examples/DeploymentScripts_Create_Using_Existing_StorageAccount.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ScriptNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: deploymentScript
        in: body
        required: true
        schema:
          $ref: '#/definitions/DeploymentScript'
        description: Deployment script supplied to the operation.
      responses:
        '200':
          description: OK -- Deployment script is updated.
          schema:
            $ref: '#/definitions/DeploymentScript'
        '201':
          description: Created -- Deployment script created.
          schema:
            $ref: '#/definitions/DeploymentScript'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/DeploymentScriptsError'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deploymentscripts Scriptname
    patch:
      tags:
      - DeploymentScripts
      operationId: microsoftAzureDeploymentscriptsUpdate
      description: Updates deployment script tags with specified values.
      x-ms-examples:
        DeploymentScriptsUpdate:
          $ref: ./examples/DeploymentScripts_Update.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ScriptNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: deploymentScript
        in: body
        schema:
          $ref: '#/definitions/DeploymentScriptUpdateParameter'
        description: Deployment script resource with the tags to be updated.
      responses:
        '200':
          description: OK -- Deployment script tags are updated.
          schema:
            $ref: '#/definitions/DeploymentScript'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/DeploymentScriptsError'
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deploymentscripts Scriptname
    get:
      tags:
      - DeploymentScripts
      operationId: microsoftAzureDeploymentscriptsGet
      description: Gets a deployment script with a given name.
      x-ms-examples:
        DeploymentScriptsGet:
          $ref: ./examples/DeploymentScripts_Get.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ScriptNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK -- Returns information about the deployment script.
          schema:
            $ref: '#/definitions/DeploymentScript'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/DeploymentScriptsError'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deploymentscripts Scriptname
    delete:
      tags:
      - DeploymentScripts
      operationId: microsoftAzureDeploymentscriptsDelete
      description: Deletes a deployment script. When operation completes, status code 200 returned without content.
      x-ms-examples:
        DeploymentScriptsDelete:
          $ref: ./examples/DeploymentScripts_Delete.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ScriptNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK -- Deployment script deleted.
        '204':
          description: Deployment script does not exist.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/DeploymentScriptsError'
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deploymentscripts Scriptname
  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentScripts:
    get:
      tags:
      - DeploymentScripts
      operationId: microsoftAzureDeploymentscriptsListbysubscription
      description: Lists all deployment scripts for a given subscription.
      x-ms-examples:
        DeploymentScriptsListBySubscription:
          $ref: ./examples/DeploymentScripts_ListBySubscription.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK -- Returns a list of deployment scripts.
          schema:
            $ref: '#/definitions/DeploymentScriptListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/DeploymentScriptsError'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Resources Deploymentscripts
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}/logs
  : get:
      tags:
      - DeploymentScripts
      operationId: microsoftAzureDeploymentscriptsGetlogs
      description: Gets deployment script logs for a given deployment script name.
      x-ms-examples:
        DeploymentScriptsGetLogs:
          $ref: ./examples/DeploymentScripts_GetLogs.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ScriptNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK -- Returns deployment script logs if available.
          schema:
            $ref: '#/definitions/ScriptLogsList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/DeploymentScriptsError'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deploymentscripts Scriptname Logs
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}/logs/default
  : get:
      tags:
      - DeploymentScripts
      operationId: microsoftAzureDeploymentscriptsGetlogsdefault
      description: Gets deployment script logs for a given deployment script name.
      x-ms-examples:
        DeploymentScriptsGetLogs:
          $ref: ./examples/DeploymentScripts_GetLogsDefault.json
        DeploymentScriptsGetLogsWithTail:
          $ref: ./examples/DeploymentScripts_GetLogsDefaultWithTail.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ScriptNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: tail
        in: query
        description: The number of lines to show from the tail of the deployment script log. Valid value is a positive number up to 1000. If 'tail' is not provided, all available logs are shown up to container instance log capacity of 4mb.
        type: integer
      responses:
        '200':
          description: OK -- Returns deployment script logs if available.
          schema:
            $ref: '#/definitions/ScriptLog'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/DeploymentScriptsError'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deploymentscripts Scriptname Logs Default
  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts:
    get:
      tags:
      - DeploymentScripts
      operationId: microsoftAzureDeploymentscriptsListbyresourcegroup
      description: Lists deployments scripts.
      x-ms-examples:
        DeploymentScriptsList:
          $ref: ./examples/DeploymentScripts_ListByResourceGroup.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK -- Returns a list of deployment scripts.
          schema:
            $ref: '#/definitions/DeploymentScriptListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/DeploymentScriptsError'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deploymentscripts
definitions:
  UserAssignedIdentity:
    type: object
    description: User-assigned managed identity.
    properties:
      principalId:
        readOnly: true
        type: string
        description: Azure Active Directory principal ID associated with this identity.
      clientId:
        readOnly: true
        type: string
        description: Client App Id associated with this identity.
  ManagedServiceIdentity:
    type: object
    description: Managed identity generic object.
    properties:
      type:
        type: string
        description: Type of the managed identity.
        enum:
        - UserAssigned
        x-ms-enum:
          name: ManagedServiceIdentityType
          modelAsString: true
      tenantId:
        readOnly: true
        type: string
        description: ID of the Azure Active Directory.
      userAssignedIdentities:
        type: object
        description: The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.
        additionalProperties:
          description: User-assigned managed identity.
          $ref: '#/definitions/UserAssignedIdentity'
  ScriptLog:
    type: object
    description: Script execution log object.
    properties:
      properties:
        $ref: '#/definitions/LogProperties'
        x-ms-client-flatten: true
    allOf:
    - $ref: '#/definitions/AzureResourceBase'
  DeploymentScript:
    required:
    - identity
    - location
    - kind
    type: object
    description: Deployment script object.
    discriminator: kind
    properties:
      identity:
        description: Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported.
        $ref: '#/definitions/ManagedServiceIdentity'
      location:
        type: string
        x-ms-mutability:
        - read
        - create
        description: The location of the ACI and the storage account for the deployment script.
      tags:
        type: object
        description: Resource tags.
        additionalProperties:
          type: string
      kind:
        type: string
        description: Type of the script.
        enum:
        - AzurePowerShell
        - AzureCLI
        x-ms-enum:
          name: ScriptType
          modelAsString: true
      systemData:
        readOnly: true
        description: The system metadata related to this resource.
        $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/systemData
    allOf:
    - $ref: '#/definitions/AzureResourceBase'
  LogProperties:
    type: object
    description: Script log properties.
    properties:
      log:
        type: string
        readOnly: true
        description: Script execution logs in text format.
  ScriptLogsList:
    description: Deployment script execution logs.
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/ScriptLog'
        description: Deployment scripts logs.
  DeploymentScriptUpdateParameter:
    type: object
    description: 'Deployment script parameters to be updated. '
    properties:
      tags:
        type: object
        description: Resource tags to be updated.
        additionalProperties:
          type: string
    allOf:
    - $ref: '#/definitions/AzureResourceBase'
  DeploymentScriptListResult:
    description: List of deployment scripts.
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/DeploymentScript'
        description: An array of deployment scripts.
      nextLink:
        readOnly: true
        type: string
        description: The URL to use for getting the next set of results.
  AzureResourceBase:
    x-ms-azure-resource: true
    type: object
    description: Common properties for all Azure resources.
    properties:
      id:
        readOnly: true
        type: string
        description: String Id used to locate any resource on Azure.
      name:
        readOnly: true
        type: string
        description: Name of this resource.
      type:
        readOnly: true
        type: string
        description: Type of this resource.
  DeploymentScriptsError:
    properties:
      error:
        $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse
    description: Deployment scripts error response.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    x-ms-parameter-location: client
    description: Client Api version.
  ScriptNameParameter:
    name: scriptName
    in: path
    required: true
    type: string
    description: Name of the deployment script.
    minLength: 1
    maxLength: 90
    x-ms-parameter-location: method
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    x-ms-parameter-location: client
    description: Subscription Id which forms part of the URI for every service call.
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    description: The name of the resource group. The name is case insensitive.
    pattern: ^[-\w\._\(\)]+$
    minLength: 1
    maxLength: 90
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'