Microsoft Azure

BlueprintClient: Blueprint Definition

Azure Blueprints Client provides access to blueprint definitions, assignments, and artifacts, and related blueprint operations.

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Azure Blueprints Client provides access to blueprint definitions, assignments, and artifacts, and related blueprint operations.

Endpoints 14

Blueprint

  • GETBlueprints_List/:scope/providers/Microsoft.Blueprint/blueprints?api-version=stringList blueprint definitions.
  • GETBlueprints_Get/:scope/providers/Microsoft.Blueprint/blueprints/:blueprintName?api-version=stringGet a blueprint definition.
  • PUTBlueprints_CreateOrUpdate/:scope/providers/Microsoft.Blueprint/blueprints/:blueprintName?api-version=stringCreate or update a blueprint definition.
  • DELETEBlueprints_Delete/:scope/providers/Microsoft.Blueprint/blueprints/:blueprintName?api-version=stringDelete a blueprint definition.

Artifact

  • GETArtifacts_List/:scope/providers/Microsoft.Blueprint/blueprints/:blueprintName/artifacts?api-version=stringList artifacts for a given blueprint definition.
  • GETArtifacts_Get/:scope/providers/Microsoft.Blueprint/blueprints/:blueprintName/artifacts/:artifactName?api-version=stringGet a blueprint artifact.
  • PUTArtifacts_CreateOrUpdate/:scope/providers/Microsoft.Blueprint/blueprints/:blueprintName/artifacts/:artifactName?api-version=stringCreate or update blueprint artifact.
  • DELETEArtifacts_Delete/:scope/providers/Microsoft.Blueprint/blueprints/:blueprintName/artifacts/:artifactName?api-version=stringDelete a blueprint artifact.

PublishedBlueprint

  • GETPublishedBlueprints_List/:scope/providers/Microsoft.Blueprint/blueprints/:blueprintName/versions?api-version=stringList published versions of given blueprint definition.
  • GETPublishedBlueprints_Get/:scope/providers/Microsoft.Blueprint/blueprints/:blueprintName/versions/:versionId?api-version=stringGet a published version of a blueprint definition.
  • PUTPublishedBlueprints_Create/:scope/providers/Microsoft.Blueprint/blueprints/:blueprintName/versions/:versionId?api-version=stringPublish a new version of the blueprint definition with the latest artifacts. Published blueprint definitions are immutable.
  • DELETEPublishedBlueprints_Delete/:scope/providers/Microsoft.Blueprint/blueprints/:blueprintName/versions/:versionId?api-version=stringDelete a published version of a blueprint definition.

PublishedArtifact

  • GETPublishedArtifacts_List/:scope/providers/Microsoft.Blueprint/blueprints/:blueprintName/versions/:versionId/artifacts?api-version=stringList artifacts for a version of a published blueprint definition.
  • GETPublishedArtifacts_Get/:scope/providers/Microsoft.Blueprint/blueprints/:blueprintName/versions/:versionId/artifacts/:artifactName?api-version=stringGet an artifact for a published blueprint definition.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
14 operations on 8 pathsGET 8PUT 3DELETE 3
Main resources
Artifact 4Blueprint 4PublishedBlueprint 4PublishedArtifact 2
Response formats
application/json
Description format
Swagger 2.0, API version 2018-11-01-preview
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the BlueprintClient: Blueprint Definition in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the BlueprintClient: Blueprint Definition collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Blueprints_List” (GET /:scope/providers/Microsoft.Blueprint/blueprints?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the BlueprintClient: Blueprint Definition?

Azure Blueprints Client provides access to blueprint definitions, assignments, and artifacts, and related blueprint operations. It is listed under Developer tools and has 14 endpoints.

Who publishes the BlueprintClient: Blueprint Definition?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the BlueprintClient: Blueprint Definition?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the BlueprintClient: Blueprint Definition?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the BlueprintClient: Blueprint Definition have?

14 operations on 8 paths (8 GET, 3 PUT, 3 DELETE). The largest groups are Artifact, Blueprint, PublishedBlueprint, PublishedArtifact.

Is forking the BlueprintClient: Blueprint Definition free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.