swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector PublishedBlueprint API
schemes:
- https
tags:
- name: PublishedBlueprint
paths:
  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions/{versionId}:
    put:
      tags:
      - PublishedBlueprint
      operationId: microsoftAzurePublishedblueprintsCreate
      description: Publish a new version of the blueprint definition with the latest artifacts. Published blueprint definitions are immutable.
      x-ms-examples:
        PublishedSubscriptionBlueprint_Publish:
          $ref: ./examples/subscriptionBPDef/SealedBlueprint_Publish.json
        PublishedManagementGroupBlueprint_Publish:
          $ref: ./examples/managementGroupBPDef/SealedBlueprint_Publish.json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/BlueprintNameParameter'
      - $ref: '#/parameters/PublishedBlueprintVersionIdParameter'
      - name: publishedBlueprint
        in: body
        required: false
        schema:
          $ref: '#/definitions/PublishedBlueprint'
        description: Published Blueprint to create or update.
      responses:
        '201':
          description: Created -- blueprint definition published.
          schema:
            $ref: '#/definitions/PublishedBlueprint'
        default:
          description: Blueprints error response.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Put Resourcescope Providers Microsoft Blueprint Blueprints Blueprintname Versions Versionid
    get:
      tags:
      - PublishedBlueprint
      operationId: microsoftAzurePublishedblueprintsGet
      description: Get a published version of a blueprint definition.
      x-ms-examples:
        PublishedSubscriptionBlueprint:
          $ref: ./examples/subscriptionBPDef/SealedBlueprint_Get.json
        PublishedManagementGroupBlueprint:
          $ref: ./examples/managementGroupBPDef/SealedBlueprint_Get.json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/BlueprintNameParameter'
      - $ref: '#/parameters/PublishedBlueprintVersionIdParameter'
      responses:
        '200':
          description: OK -- published blueprint definition retrieved.
          schema:
            $ref: '#/definitions/PublishedBlueprint'
        default:
          description: Blueprints error response.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Get Resourcescope Providers Microsoft Blueprint Blueprints Blueprintname Versions Versionid
    delete:
      tags:
      - PublishedBlueprint
      operationId: microsoftAzurePublishedblueprintsDelete
      description: Delete a published version of a blueprint definition.
      x-ms-examples:
        PublishedSubscriptionBlueprint:
          $ref: ./examples/subscriptionBPDef/SealedBlueprint_Delete.json
        PublishedManagementGroupBlueprint:
          $ref: ./examples/managementGroupBPDef/SealedBlueprint_Delete.json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/BlueprintNameParameter'
      - $ref: '#/parameters/PublishedBlueprintVersionIdParameter'
      responses:
        '200':
          description: OK -- published version of blueprint definition deleted.
          schema:
            $ref: '#/definitions/PublishedBlueprint'
        '204':
          description: No Content
        default:
          description: Blueprints error response.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Delete Resourcescope Providers Microsoft Blueprint Blueprints Blueprintname Versions Versionid
  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions:
    get:
      tags:
      - PublishedBlueprint
      operationId: microsoftAzurePublishedblueprintsList
      description: List published versions of given blueprint definition.
      x-ms-examples:
        PublishedSubscriptionBlueprint:
          $ref: ./examples/subscriptionBPDef/SealedBlueprint_List.json
        PublishedManagementGroupBlueprint:
          $ref: ./examples/managementGroupBPDef/SealedBlueprint_List.json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/BlueprintNameParameter'
      responses:
        '200':
          description: OK -- all published versions of blueprint definition retrieved.
          schema:
            $ref: '#/definitions/PublishedBlueprintList'
        default:
          description: Blueprints error response.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Resourcescope Providers Microsoft Blueprint Blueprints Blueprintname Versions
definitions:
  ParameterDefinition:
    description: Represent a parameter with constrains and metadata.
    type: object
    properties:
      type:
        type: string
        description: Allowed data types for Resource Manager template parameters.
        enum:
        - string
        - array
        - bool
        - int
        - object
        - secureObject
        - secureString
        x-ms-enum:
          name: TemplateParameterType
          modelAsString: true
      metadata:
        description: User-friendly properties for this parameter.
        x-ms-client-flatten: true
        $ref: '#/definitions/ParameterDefinitionMetadata'
      defaultValue:
        description: Default Value for this parameter.
      allowedValues:
        type: array
        description: Array of allowed values for this parameter.
        items:
          description: Allowed value.
    required:
    - type
  ResourceGroupDefinition:
    description: Represents an Azure resource group in a blueprint definition.
    type: object
    properties:
      name:
        type: string
        description: Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.
      location:
        type: string
        description: Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.
      metadata:
        description: User-friendly properties for this resource group.
        x-ms-client-flatten: true
        $ref: '#/definitions/ParameterDefinitionMetadata'
      dependsOn:
        type: array
        description: Artifacts which need to be deployed before this resource group.
        items:
          type: string
          description: Name of peer artifact.
      tags:
        description: Tags to be assigned to this resource group.
        type: object
        additionalProperties:
          type: string
  CloudError:
    x-ms-external: true
    properties:
      error:
        $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse
  PublishedBlueprintList:
    type: object
    title: BlueprintList
    description: List of published blueprint definitions.
    properties:
      value:
        type: array
        description: List of published blueprint definitions.
        items:
          $ref: '#/definitions/PublishedBlueprint'
      nextLink:
        type: string
        readOnly: true
        description: Link to the next page of results.
  SharedBlueprintProperties:
    description: Shared Schema for both blueprintProperties and publishedBlueprintProperties.
    type: object
    x-ms-external: true
    properties:
      status:
        description: Status of the blueprint. This field is readonly.
        readOnly: true
        $ref: '#/definitions/BlueprintStatus'
      targetScope:
        type: string
        description: The scope where this blueprint definition can be assigned.
        enum:
        - subscription
        - managementGroup
        x-ms-enum:
          name: BlueprintTargetScope
          modelAsString: true
          values:
          - value: subscription
            description: The blueprint targets a subscription during blueprint assignment.
          - value: managementGroup
            description: The blueprint targets a management group during blueprint assignment. This is reserved for future use.
      parameters:
        description: Parameters required by this blueprint definition.
        type: object
        additionalProperties:
          description: Named collection of parameter metadata.
          $ref: '#/definitions/ParameterDefinition'
      resourceGroups:
        description: Resource group placeholders defined by this blueprint definition.
        type: object
        additionalProperties:
          description: Named collection for resourceGroupDefinition.
          $ref: '#/definitions/ResourceGroupDefinition'
    allOf:
    - $ref: '#/definitions/BlueprintResourcePropertiesBase'
  BlueprintResourcePropertiesBase:
    description: Shared properties between all blueprint resources.
    type: object
    x-ms-external: true
    properties:
      displayName:
        type: string
        description: One-liner string explain this resource.
        maxLength: 256
      description:
        type: string
        description: Multi-line explain this resource.
        maxLength: 500
  BlueprintStatus:
    description: The status of the blueprint. This field is readonly.
    type: object
    properties: {}
    allOf:
    - $ref: '#/definitions/BlueprintResourceStatusBase'
  PublishedBlueprint:
    type: object
    description: Represents a published blueprint.
    allOf:
    - $ref: '#/definitions/AzureResourceBase'
    properties:
      properties:
        description: Detailed properties for published blueprint.
        x-ms-client-flatten: true
        $ref: '#/definitions/PublishedBlueprintProperties'
    required:
    - properties
  PublishedBlueprintProperties:
    description: Schema for published blueprint definition properties.
    type: object
    x-ms-external: true
    allOf:
    - $ref: '#/definitions/SharedBlueprintProperties'
    properties:
      blueprintName:
        description: Name of the published blueprint definition.
        type: string
      changeNotes:
        description: Version-specific change notes.
        type: string
        maxLength: 500
  AzureResourceBase:
    description: Common properties for all Azure resources.
    type: object
    x-ms-azure-resource: true
    properties:
      id:
        readOnly: true
        type: string
        description: String Id used to locate any resource on Azure.
      type:
        readOnly: true
        type: string
        description: Type of this resource.
      name:
        readOnly: true
        type: string
        description: Name of this resource.
  ParameterDefinitionMetadata:
    type: object
    description: User-friendly properties for this parameter.
    properties:
      displayName:
        type: string
        description: DisplayName of this parameter/resourceGroup.
        maxLength: 256
      description:
        type: string
        description: Description of this parameter/resourceGroup.
        maxLength: 500
      strongType:
        type: string
        description: StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location.
        maxLength: 64
  BlueprintResourceStatusBase:
    description: Shared status properties between all blueprint resources.
    type: object
    properties:
      timeCreated:
        type: string
        format: date-time
        readOnly: true
        description: Creation time of this blueprint definition.
      lastModified:
        type: string
        format: date-time
        readOnly: true
        description: Last modified time of this blueprint definition.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    x-ms-parameter-location: client
    description: Client API Version.
  PublishedBlueprintVersionIdParameter:
    name: versionId
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
    description: Version of the published blueprint definition.
  ScopeParameter:
    name: resourceScope
    in: path
    required: true
    type: string
    description: 'The scope of the resource. Valid scopes are: management group (format: ''/providers/Microsoft.Management/managementGroups/{managementGroup}''), subscription (format: ''/subscriptions/{subscriptionId}'').'
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
  BlueprintNameParameter:
    name: blueprintName
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
    description: Name of the blueprint definition.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'