Microsoft Azure

Azure Resourceconnector

The appliances Rest API spec.

Developer tools#openapi

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

The appliances Rest API spec.

Endpoints 11

Appliances

  • GETGets a list of Appliances in a subscription./subscriptions/:subscriptionId/providers/Microsoft.ResourceConnector/appliancesGets a list of Appliances in the specified subscription. The operation returns properties of each Appliance
  • GETGets a list of Appliances in the specified subscription and resource group./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ResourceConnector/appliancesGets a list of Appliances in the specified subscription and resource group. The operation returns properties of each Appliance.
  • GETGets an Appliance./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ResourceConnector/appliances/:resourceNameGets the details of an Appliance with a specified resource group and name.
  • PUTCreates or updates an Appliance./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ResourceConnector/appliances/:resourceNameCreates or updates an Appliance in the specified Subscription and Resource Group.
  • DELETEDeletes an Appliance./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ResourceConnector/appliances/:resourceNameDeletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id.
  • PATCHUpdates an Appliance./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ResourceConnector/appliances/:resourceNameUpdates an Appliance with the specified Resource Name in the specified Resource Group and Subscription.
  • POSTReturns the cluster user credential./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ResourceConnector/appliances/:resourceName/listClusterUserCredentialReturns the cluster user credentials for the dedicated appliance.
  • POSTGets the management config./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ResourceConnector/appliances/:resourceName/listkeys?artifactType=stringReturns the cluster customer credentials for the dedicated appliance.
  • GETGets an Appliance upgrade graph./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ResourceConnector/appliances/:resourceName/upgradeGraphs/:upgradeGraphGets the upgrade graph of an Appliance with a specified resource group and name and specific release train.

Operations

  • GETAppliances_ListOperations/providers/Microsoft.ResourceConnector/operationsLists all available Appliances operations.
  • GETGets the telemetry config./subscriptions/:subscriptionId/providers/Microsoft.ResourceConnector/telemetryconfigGets the telemetry config.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
11 operations on 8 pathsGET 6POST 2PUT 1PATCH 1DELETE 1
Main resources
Appliances 9Operations 1
Response formats
application/json
Description format
Swagger 2.0, API version 2022-10-27

How to test the Azure Resourceconnector 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 Azure Resourceconnector 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 “Gets a list of Appliances in a subscription.” (GET /subscriptions/:subscriptionId/providers/Microsoft.ResourceConnector/appliances), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Resourceconnector?

The appliances Rest API spec. It is listed under Developer tools and has 11 endpoints.

Who publishes the Azure Resourceconnector?

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 Azure Resourceconnector?

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

How do I authenticate with the Azure Resourceconnector?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Resourceconnector have?

11 operations on 8 paths (6 GET, 2 POST, 1 PUT, 1 PATCH, 1 DELETE). The largest groups are Appliances, Operations.

Is forking the Azure Resourceconnector 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.