CrayonApi
  • Getting Started
  • Scenarios
    • Authentication
    • Organization
    • Manage users
    • Manage customer tenant
    • Manage agreements
    • Manage subscriptions
    • Manage Azure Plan
    • Products
    • Billing and invoicing
    • Usage costs
    • Management links
      • Get management links
      • Get management links grouped
    • Azure Usage
  • Resources
  • Samples
CrayonApi
  • Scenarios
  • Management links
  • Get management links
  • View page source

Get management links¶

Returns links to where subscriptions can be managed.

Prerequisites¶

  • Credentials as described in Authentication

C#¶

To get management links, first create an instance of CrayonApiClient and get the token using CrayonApiClient instance.

Then call ManagementLinkResource.Get() method to get the management links by passing token.

var client = new CrayonApiClient("https://api.crayon.com/");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;

var result = client.ManagementLinkResource.Get(token);

Request¶

Request Syntax:

Method Request URI
GET https://api.crayon.com//api/v1/managementlinks/?resellerCustomerIds={resellerCustomerIds}&subscriptionIds={subscriptionIds}&page={page}&pageSize={pageSize}

Request Parameters:

Name Type Description
resellerCustomerIds int[] Customer tenant identifiers
subscriptionIds int[] Subscriptions to get links for
page int Pagination, starts at page 1
pageSize int Pagination, Number of objects to return

Request Headers:

The following HTTP request headers are supported

Header Type Description
Authorization string Required. The authorization token in the form Bearer <token>.
Accept string Specifies the request and response type, “application/json”.
Content-Type string Specifies the media type of the resource, “application/json”.

Request Example:

GET $"/api/v1/managementlinks/?resellerCustomerIds={resellerCustomerIds}&subscriptionIds={subscriptionIds}&page={page}&pageSize={pageSize}
Accept : application/json
Content-Type: application/json
Authorization : Bearer < Token >

Response¶

If successful, this method returns the list of ManagementLink

{
  "Link": "https://portal.azure.com/testcompany.onmicrosoft.com",
  "ResellerCustomer": {
    "Id": 343,
    "Name": "TestResellerCustomer"
  },
  "Subscription": {
    "Id": "1e62d4f6-f056-4442-af01-341465be6d6a",
    "Name": "My Subscription"
  },
  "Text": "Microsoft Azure Management Portal"
}

Response success and error codes:

Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters.

Error Codes Description
200 Ok The request has succeeded.
401 Unauthorized The request requires user authentication. If the request already included Authorization credentials, then the 401 (Unauthorized) status code means that authorization has been refused for those credentials. It is a non-retryable error condition.

Was this page helpful?

Your feedback about this content is important. Let us know what you think. Yes No

Was this page helpful?

Sorry this wasn't helpful. characters remaining Submit Skip this
✖
Sending feedback...
Thank you for your feedback!
Error during submission!
Previous Next

© Copyright 2022, Crayon Group. Last updated on Mar 14, 2023.