Microsoft Azure
Microsoft Azure Artifact API

The Artifact API from Microsoft Azure — 18 operation(s) for artifact.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Artifact API
schemes:
- https
tags:
- name: Artifact
paths:
  ? /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/metadata
  : post:
      tags:
      - Artifact
      summary: Microsoft Azure Create Artifact
      description: Create an Artifact.
      operationId: microsoftAzureArtifactsCreate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: artifact
        in: body
        description: The Artifact details.
        required: true
        schema:
          $ref: '#/definitions/Artifact'
      responses:
        '200':
          description: The Artifact is created successfully.
          schema:
            $ref: '#/definitions/Artifact'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
  ? /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/register
  : post:
      tags:
      - Artifact
      summary: Microsoft Azure Create An Artifact For An Existing Data Location
      description: Create an Artifact for an existing dataPath.
      operationId: microsoftAzureArtifactsRegister
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: artifact
        in: body
        description: The Artifact creation details.
        required: true
        schema:
          $ref: '#/definitions/Artifact'
      responses:
        '200':
          description: The Artifact is created successfully.
          schema:
            $ref: '#/definitions/Artifact'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
  ? /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/metadata
  : get:
      tags:
      - Artifact
      summary: Microsoft Azure Get Artifact Metadata By Id
      description: Get Artifact metadata for a specific Id.
      operationId: microsoftAzureArtifactsGet
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: origin
        in: path
        description: The origin of the Artifact.
        required: true
        type: string
      - name: container
        in: path
        description: The container name.
        required: true
        type: string
      - name: path
        in: query
        description: The Artifact Path.
        required: true
        type: string
      responses:
        '200':
          description: The details of the Artifact are returned successfully.
          schema:
            $ref: '#/definitions/Artifact'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
    delete:
      tags:
      - Artifact
      summary: Microsoft Azure Delete Artifact Metadata
      description: Delete an Artifact Metadata.
      operationId: microsoftAzureArtifactsDeletemetadata
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: origin
        in: path
        description: The origin of the Artifact.
        required: true
        type: string
      - name: container
        in: path
        description: The container name.
        required: true
        type: string
      - name: path
        in: query
        description: The Artifact Path.
        required: false
        type: string
      - name: hardDelete
        in: query
        description: If set to true. The delete cannot be revert at later time.
        required: false
        type: boolean
        default: false
      responses:
        '200':
          description: The Artifact metadata deleted successfully.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
  ? /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}
  : get:
      tags:
      - Artifact
      summary: Microsoft Azure Get Artifacts Metadata In A Container Or Path
      description: Get Artifacts metadata in a specific container or path.
      operationId: microsoftAzureArtifactsListincontainer
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: origin
        in: path
        description: The origin of the Artifact.
        required: true
        type: string
      - name: container
        in: path
        description: The container name.
        required: true
        type: string
      - name: path
        in: query
        description: The Artifact Path.
        required: false
        type: string
      - name: continuationToken
        in: query
        description: The continuation token.
        required: false
        type: string
      responses:
        '200':
          description: The details of the Artifacts are returned successfully.
          schema:
            $ref: '#/definitions/PaginatedArtifactList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
  ? /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/content
  : get:
      tags:
      - Artifact
      summary: Microsoft Azure Get Artifact Content By Id
      description: Get Artifact content of a specific Id.
      operationId: microsoftAzureArtifactsDownload
      consumes: []
      produces:
      - application/json
      - application/octet-stream
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: origin
        in: path
        description: The origin of the Artifact.
        required: true
        type: string
      - name: container
        in: path
        description: The container name.
        required: true
        type: string
      - name: path
        in: query
        description: The Artifact Path.
        required: false
        type: string
      responses:
        '200':
          description: File Response
          schema:
            format: byte
            type: file
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
    post:
      tags:
      - Artifact
      summary: Microsoft Azure Upload Artifact Content
      description: Upload content to an Artifact.
      operationId: microsoftAzureArtifactsUpload
      consumes:
      - application/octet-stream
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: origin
        in: path
        description: The origin of the Artifact.
        required: true
        type: string
      - name: container
        in: path
        description: The container name.
        required: true
        type: string
      - name: path
        in: query
        description: The Artifact Path.
        required: false
        type: string
      - name: index
        in: query
        description: The index.
        required: false
        type: integer
        format: int32
      - name: append
        in: query
        description: Whether or not to append the content or replace it.
        required: false
        type: boolean
        default: false
      - name: allowOverwrite
        in: query
        description: whether to allow overwrite if Artifact Content exist already. when set to true, Overwrite happens if Artifact Content already exists
        required: false
        type: boolean
        default: false
      - name: content
        in: body
        description: The file upload.
        required: true
        schema:
          format: binary
          type: string
      responses:
        '200':
          description: The Artifact content is uploaded successfully.
          schema:
            $ref: '#/definitions/Artifact'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
  ? /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/contentinfo
  : get:
      tags:
      - Artifact
      summary: Microsoft Azure Get Artifact Content Information
      description: Get content information of an Artifact.
      operationId: microsoftAzureArtifactsGetcontentinformation
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: origin
        in: path
        description: The origin of the Artifact.
        required: true
        type: string
      - name: container
        in: path
        description: The container name.
        required: true
        type: string
      - name: path
        in: query
        description: The Artifact Path.
        required: false
        type: string
      responses:
        '200':
          description: The Artifact content information is returned successfully.
          schema:
            $ref: '#/definitions/ArtifactContentInformation'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
  ? /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/contentinfo/storageuri
  : get:
      tags:
      - Artifact
      summary: Microsoft Azure Get Artifact Storage Content Information
      description: Get storage content information of an Artifact.
      operationId: microsoftAzureArtifactsGetstoragecontentinformation
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: origin
        in: path
        description: The origin of the Artifact.
        required: true
        type: string
      - name: container
        in: path
        description: The container name.
        required: true
        type: string
      - name: path
        in: query
        description: The Artifact Path.
        required: false
        type: string
      responses:
        '200':
          description: The Artifact storage content information is returned successfully.
          schema:
            $ref: '#/definitions/ArtifactContentInformation'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
  ? /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/write
  : get:
      tags:
      - Artifact
      summary: Microsoft Azure Get Writable Shared Access Signature For Artifact
      description: Get writable shared access signature for a specific Artifact.
      operationId: microsoftAzureArtifactsGetsas
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: origin
        in: path
        description: The origin of the Artifact.
        required: true
        type: string
      - name: container
        in: path
        description: The container name.
        required: true
        type: string
      - name: path
        in: query
        description: The Artifact Path.
        required: false
        type: string
      responses:
        '200':
          description: The Artifact writable shared access signature is returned successfully.
          schema:
            $ref: '#/definitions/ArtifactContentInformation'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
  ? /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/prefix/contentinfo
  : get:
      tags:
      - Artifact
      summary: Microsoft Azure Get Shared Access Signature For An Artifact
      description: Get shared access signature for an Artifact in specific path.
      operationId: microsoftAzureArtifactsListsasbyprefix
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: origin
        in: path
        description: The origin of the Artifact.
        required: true
        type: string
      - name: container
        in: path
        description: The container name.
        required: true
        type: string
      - name: path
        in: query
        description: The Artifact Path.
        required: false
        type: string
      - name: continuationToken
        in: query
        description: The continuation token.
        required: false
        type: string
      responses:
        '200':
          description: The Artifact writable shared access signature is returned successfully.
          schema:
            $ref: '#/definitions/PaginatedArtifactContentInformationList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
  ? /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/prefix/contentinfo/storageuri
  : get:
      tags:
      - Artifact
      summary: Microsoft Azure Get Storage Uri For Artifacts In A Path
      description: Get storage Uri for Artifacts in a specific path.
      operationId: microsoftAzureArtifactsListstorageuribyprefix
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: origin
        in: path
        description: The origin of the Artifact.
        required: true
        type: string
      - name: container
        in: path
        description: The container name.
        required: true
        type: string
      - name: path
        in: query
        description: The Artifact Path.
        required: false
        type: string
      - name: continuationToken
        in: query
        description: The continuation token.
        required: false
        type: string
      responses:
        '200':
          description: The Artifact storage uri is returned successfully.
          schema:
            $ref: '#/definitions/PaginatedArtifactContentInformationList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
  ? /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/batch/metadata
  : post:
      tags:
      - Artifact
      summary: Microsoft Azure Get Batch Artifacts By Ids
      description: Get Batch Artifacts by the specific Ids.
      operationId: microsoftAzureArtifactsBatchgetbyid
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: artifactIds
        in: body
        description: The command for Batch Artifact get request.
        required: true
        schema:
          $ref: '#/definitions/ArtifactIdList'
      responses:
        '200':
          description: The requested Batch Artifacts are returned successfully.
          schema:
            $ref: '#/definitions/BatchArtifactContentInformationResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
  ? /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/storageuri/batch/metadata
  : post:
      tags:
      - Artifact
      summary: Microsoft Azure Get Batch Artifacts Storage By Ids
      description: Get Batch Artifacts storage by specific Ids.
      operationId: microsoftAzureArtifactsBatchgetstoragebyid
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: artifactIds
        in: body
        description: The list of artifactIds to get.
        required: true
        schema:
          $ref: '#/definitions/ArtifactIdList'
      responses:
        '200':
          description: The Batch Artifact's storage are returned successfully.
          schema:
            $ref: '#/definitions/BatchArtifactContentInformationResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
  ? /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/batch/ingest/containersas
  : post:
      tags:
      - Artifact
      summary: Microsoft Azure Batch Ingest Using Shared Access Signature
      description: Ingest Batch Artifacts using shared access signature.
      operationId: microsoftAzureArtifactsBatchingestfromsas
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: origin
        in: path
        description: The origin of the Artifact.
        required: true
        type: string
      - name: container
        in: path
        description: The container name.
        required: true
        type: string
      - name: artifactContainerSas
        in: body
        description: The artifact container shared access signature to use for batch ingest.
        required: true
        schema:
          $ref: '#/definitions/ArtifactContainerSas'
      responses:
        '200':
          description: The Batch is ingested using shared access signature successfully.
          schema:
            $ref: '#/definitions/PaginatedArtifactList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
  ? /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/batch/metadata
  : post:
      tags:
      - Artifact
      summary: Microsoft Azure Create A Batch Of Empty Artifacts
      description: Create a Batch of empty Artifacts from the supplied paths.
      operationId: microsoftAzureArtifactsBatchcreateemptyartifacts
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: origin
        in: path
        description: The origin of the Artifact.
        required: true
        type: string
      - name: container
        in: path
        description: The container name.
        required: true
        type: string
      - name: artifactPaths
        in: body
        description: The list of Artifact paths to create.
        required: true
        schema:
          $ref: '#/definitions/ArtifactPathList'
      responses:
        '200':
          description: The Batch of empty Artifacts created successfully.
          schema:
            $ref: '#/definitions/BatchArtifactContentInformationResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
  ? /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/batch/metadata:delete
  : post:
      tags:
      - Artifact
      summary: Microsoft Azure Delete Batch Of Artifact Metadata
      description: Delete a Batch of Artifact Metadata.
      operationId: microsoftAzureArtifactsDeletebatchmetadata
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: origin
        in: path
        description: The origin of the Artifact.
        required: true
        type: string
      - name: container
        in: path
        description: The container name.
        required: true
        type: string
      - name: artifactPaths
        in: body
        description: The list of Artifact paths to delete.
        required: true
        schema:
          $ref: '#/definitions/ArtifactPathList'
      - name: hardDelete
        in: query
        description: If set to true, the delete cannot be reverted at a later time.
        required: false
        type: boolean
        default: false
      responses:
        '200':
          description: The batch delete of Artifact metadata completed successfully.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
  ? /artifact/v2.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/artifacts/{origin}/{container}/batch
  : delete:
      tags:
      - Artifact
      summary: Microsoft Azure Delete Artifact Metadata
      description: Delete Artifact Metadata in a specific container.
      operationId: microsoftAzureArtifactsDeletemetadataincontainer
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/workspaceNameParameter'
      - name: origin
        in: path
        description: The origin of the Artifact.
        required: true
        type: string
      - name: container
        in: path
        description: The container name.
        required: true
        type: string
      - name: hardDelete
        in: query
        description: If set to true. The delete cannot be revert at later time.
        required: false
        type: boolean
        default: false
      responses:
        '200':
          description: The Artifact metadata deleted successfully.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/artifacts/{artifactName}:
    put:
      tags:
      - Artifact
      operationId: microsoftAzureArtifactsCreateorupdate
      description: Create or update blueprint artifact.
      x-ms-examples:
        Sub-ARMTemplateArtifact:
          $ref: ./examples/subscriptionBPDef/ARMTemplateArtifact_Create.json
        Sub-PolicyAssignmentArtifact:
          $ref: ./examples/subscriptionBPDef/PolicyAssignmentArtifact_Create.json
        Sub-RoleAssignmentArtifact:
          $ref: ./examples/subscriptionBPDef/RoleAssignmentArtifact_Create.json
        MG-ARMTemplateArtifact:
          $ref: ./examples/managementGroupBPDef/ARMTemplateArtifact_Create.json
        MG-PolicyAssignmentArtifact:
          $ref: ./examples/managementGroupBPDef/PolicyAssignmentArtifact_Create.json
        MG-RoleAssignmentArtifact:
          $ref: ./examples/managementGroupBPDef/RoleAssignmentArtifact_Create.json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/BlueprintNameParameter'
      - $ref: '#/parameters/ArtifactNameParameter'
      - name: artifact
        in: body
        required: true
        schema:
          $ref: '#/definitions/Artifact_2'
        description: Blueprint artifact to create or update.
      responses:
        '201':
          description: Created -- blueprint artifact created/updated.
          schema:
            $ref: '#/definitions/Artifact_2'
        default:
          description: Blueprints error response.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Put Resourcescope Providers Microsoft Blueprint Blueprints Blueprintname Artifacts Artifactname
    get:
      tags:
      - Artifact
      operationId: microsoftAzureArtifactsGet
      description: Get a blueprint artifact.
      x-ms-examples:
        Sub-ARMTemplateArtifact:
          $ref: ./examples/subscriptionBPDef/ARMTemplateArtifact_Get.json
        Sub-PolicyAssignmentArtifact:
          $ref: ./examples/subscriptionBPDef/PolicyAssignmentArtifact_Get.json
        Sub-RoleAssignmentArtifact:
          $ref: ./examples/subscriptionBPDef/RoleAssignmentArtifact_Get.json
        MG-ARMTemplateArtifact:
          $ref: ./examples/managementGroupBPDef/ARMTemplateArtifact_Get.json
        MG-PolicyAssignmentArtifact:
          $ref: ./examples/managementGroupBPDef/PolicyAssignmentArtifact_Get.json
        MG-RoleAssignmentArtifact:
          $ref: ./examples/managementGroupBPDef/RoleAssignmentArtifact_Get.json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/BlueprintNameParameter'
      - $ref: '#/parameters/ArtifactNameParameter'
      responses:
        '200':
          description: OK -- blueprint artifact retrieved.
          schema:
            $ref: '#/definitions/Artifact_2'
        default:
          description: Blueprints error response.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Get Resourcescope Providers Microsoft Blueprint Blueprints Blueprintname Artifacts Artifactname
    delete:
      tags:
      - Artifact
      operationId: microsoftAzureArtifactsDelete
      description: Delete a blueprint artifact.
      x-ms-examples:
        Sub-ARMTemplateArtifact:
          $ref: ./examples/subscriptionBPDef/ARMTemplateArtifact_Delete.json
        Sub-PolicyAssignmentArtifact:
          $ref: ./examples/subscriptionBPDef/PolicyAssignmentArtifact_Delete.json
        Sub-RoleAssignmentArtifact:
          $ref: ./examples/subscriptionBPDef/RoleAssignmentArtifact_Delete.json
        MG-ARMTemplateArtifact:
          $ref: ./examples/managementGroupBPDef/ARMTemplateArtifact_Delete.json
        MG-PolicyAssignmentArtifact:
          $ref: ./examples/managementGroupBPDef/PolicyAssignmentArtifact_Delete.json
        MG-RoleAssignmentArtifact:
          $ref: ./examples/managementGroupBPDef/RoleAssignmentArtifact_Delete.json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/BlueprintNameParameter'
      - $ref: '#/parameters/ArtifactNameParameter'
      responses:
        '200':
          description: OK -- blueprint artifact deleted.
          schema:
            $ref: '#/definitions/Artifact_2'
        '204':
          description: No Content
        default:
          description: Blueprints error response.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Delete Resourcescope Providers Microsoft Blueprint Blueprints Blueprintname Artifacts Artifactname
  /{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/artifacts:
    get:
      tags:
      - Artifact
      operationId: microsoftAzureArtifactsList
      description: List artifacts for a given blueprint definition.
      x-ms-examples:
        Sub-ArtifactList:
          $ref: ./examples/subscriptionBPDef/Artifact_List.json
        MG-ArtifactList:
          $ref: ./examples/managementGroupBPDef/Artifact_List.json
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/BlueprintNameParameter'
      responses:
        '200':
          description: OK -- blueprint artifacts retrieved.
          schema:
            $ref: '#/definitions/ArtifactList'
        default:
          description: Blueprints error response.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Resourcescope Providers Microsoft Blueprint Blueprints Blueprintname Artifacts
definitions:
  ErrorDetails:
    description: The error details.
    type: object
    properties:
      code:
        description: The error code.
        type: string
      message:
        description: The error message.
        type: string
      target:
        description: The target of the error (e.g., the name of the property in error).
        type: string
  RootError:
    description: The root error.
    type: object
    properties:
      code:
        description: 'The service-defined error code. Supported error codes: ServiceError, UserError, ValidationError, AzureStorageError, TransientError, RequestThrottled.'
        type: string
      message:
        description: A human-readable representation of the error.
        type: string
      target:
        description: The target of the error (e.g., the name of the property in error).
        type: string
      details:
        description: The related errors that occurred during the request.
        uniqueIt

# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-artifact-api-openapi.yml
Microsoft Azure Artifact API

Documentation

Specifications

Other Resources

OpenAPI Specification
