Hybrid Cloud with Microsoft Azure APIs (v2)

Download OpenAPI specification:Download

APIs for Hybrid Cloud with Microsoft Azure.

Authentication

TokenAuth

Security Scheme Type API Key
Header parameter name: X-Auth-Token

Customer

Manage customers.

Post Customer

Authorizations:
path Parameters
tenant_id
required
string
Request Body schema: application/json
company
required
string <= 256 characters
country
required
string
Enum: "japan" "日本"
postal_code
required
string ^[0-9]{3,3}[-]?[0-9]{4,4}$
state
required
string <= 128 characters
city
required
string <= 128 characters
address1
required
string <= 200 characters
address2
string <= 200 characters
last_name
required
string <= 50 characters
first_name
required
string <= 50 characters
phone_number
required
string <= 64 characters
mailaddress
required
string <email> <= 100 characters
culture
required
string
Enum: "ja-JP" "en-US"
language
required
string
Enum: "ja" "en"

Responses

200

Request was successful.

400

Some content in the request was invalid.

401

User must authenticate before making a request.

403

Policy does not allow current user to do this operation.

404

The requested resource could not be found.

405

Method not allowed.

409

Resource already exists.

500

The request has failed due to some unknown error.

post/tenants/{tenant_id}/customer
https://api.ntt.com/ecl-hc-azure/tenants/{tenant_id}/customer

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "company": "NTT Communications Corporation",
  • "country": "japan",
  • "postal_code": "000-0000",
  • "state": "Tokyo",
  • "city": "Chiyoda-ku",
  • "address1": "Otemachi 2-3-1",
  • "address2": "Otemachi Place",
  • "last_name": "Yamada",
  • "first_name": "Taro",
  • "phone_number": "000-0000-0000",
  • "mailaddress": "user@example.com",
  • "culture": "ja-JP",
  • "language": "ja"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "status": "provisioning",
  • "companyProfile":
    {
    },
  • "billingProfile":
    {
    },
  • "userCredentials":
    {
    }
}

Get Customer

Authorizations:
path Parameters
tenant_id
required
string

Responses

200

Request was successful.

400

Some content in the request was invalid.

401

User must authenticate before making a request.

403

Policy does not allow current user to do this operation.

404

The requested resource could not be found.

405

Method not allowed.

409

Resource already exists.

500

The request has failed due to some unknown error.

get/tenants/{tenant_id}/customer
https://api.ntt.com/ecl-hc-azure/tenants/{tenant_id}/customer

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "status": "provisioning",
  • "companyProfile":
    {
    },
  • "billingProfile":
    {
    }
}

Delete Customer

Authorizations:
path Parameters
tenant_id
required
string

Responses

204

Request was successful.

400

Some content in the request was invalid.

401

User must authenticate before making a request.

403

Policy does not allow current user to do this operation.

404

The requested resource could not be found.

405

Method not allowed.

409

Resource already exists.

500

The request has failed due to some unknown error.

delete/tenants/{tenant_id}/customer
https://api.ntt.com/ecl-hc-azure/tenants/{tenant_id}/customer

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Title": "BadRequest",
  • "Message": "Bad request."
}

Domain

Manage domains.

Post Domain

Authorizations:
path Parameters
tenant_id
required
string
Request Body schema: application/json
azure_tenant_name
required
string <= 128 characters
account_name
required
string <= 128 characters
last_name
required
string <= 50 characters
first_name
required
string <= 50 characters
phone_number
required
string <= 64 characters
mailaddress
required
string <email> <= 100 characters

Responses

202

Request was successful.

400

Some content in the request was invalid.

401

User must authenticate before making a request.

403

Policy does not allow current user to do this operation.

404

The requested resource could not be found.

405

Method not allowed.

409

Resource already exists.

500

The request has failed due to some unknown error.

post/tenants/{tenant_id}/domain
https://api.ntt.com/ecl-hc-azure/tenants/{tenant_id}/domain

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "azure_tenant_name": "<Unique ID>.onmicrosoft.com",
  • "account_name": "user@<Unique ID>.onmicrosoft.com",
  • "last_name": "Yamada",
  • "first_name": "Taro",
  • "phone_number": "000-0000-0000",
  • "mailaddress": "user@example.com"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Title": "BadRequest",
  • "Message": "Bad request."
}

Subscription

Manage subscriptions.

Get Subscriptions

Authorizations:
path Parameters
tenant_id
required
string

Responses

200

Request was successful.

400

Some content in the request was invalid.

401

User must authenticate before making a request.

403

Policy does not allow current user to do this operation.

404

The requested resource could not be found.

405

Method not allowed.

409

Resource already exists.

500

The request has failed due to some unknown error.

get/tenants/{tenant_id}/subscriptions
https://api.ntt.com/ecl-hc-azure/tenants/{tenant_id}/subscriptions

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Suspend Subscription

Authorizations:
path Parameters
tenant_id
required
string
subscription_id
required
string

Responses

204

Request was successful.

400

Some content in the request was invalid.

401

User must authenticate before making a request.

403

Policy does not allow current user to do this operation.

404

The requested resource could not be found.

405

Method not allowed.

409

Resource already exists.

500

The request has failed due to some unknown error.

post/tenants/{tenant_id}/subscriptions/{subscription_id}/suspend
https://api.ntt.com/ecl-hc-azure/tenants/{tenant_id}/subscriptions/{subscription_id}/suspend

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Title": "BadRequest",
  • "Message": "Bad request."
}

Enable Subscription

Authorizations:
path Parameters
tenant_id
required
string
subscription_id
required
string

Responses

204

Request was successful.

400

Some content in the request was invalid.

401

User must authenticate before making a request.

403

Policy does not allow current user to do this operation.

404

The requested resource could not be found.

405

Method not allowed.

409

Resource already exists.

500

The request has failed due to some unknown error.

post/tenants/{tenant_id}/subscriptions/{subscription_id}/enable
https://api.ntt.com/ecl-hc-azure/tenants/{tenant_id}/subscriptions/{subscription_id}/enable

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Title": "BadRequest",
  • "Message": "Bad request."
}