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:

TokenAuth

path Parameters

tenant_id

required

string

Request Body schema: application/json

company required	string [ 2 .. 220 ] 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 [ 2 .. 40 ] characters
first_name required	string [ 2 .. 40 ] 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

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

Payload

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": 
{"tenantId": "string",
"domain": "<Unique ID>.onmicrosoft.com",
"companyName": "NTT Communications Corporation"
},
"billingProfile": 
{"id": "string",
"email": "user@example.com",
"culture": "ja-JP",
"language": "ja",
"companyName": "NTT Communications Corporation",
"defaultAddress": 
{"country": "japan",
"city": "Chiyoda-ku",
"state": "Tokyo",
"addressLine1": "Otemachi 2-3-1",
"addressLine2": "Otemachi Place",
"postalCode": "000-0000",
"firstName": "Taro",
"lastName": "Yamada",
"phoneNumber": "000-0000-0000"
}
},
"userCredentials": 
{"userName": "admin",
"password": "string"
}
}

Get Customer

Authorizations:

TokenAuth

path Parameters

tenant_id

required

string

Responses

200

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": 
{"tenantId": "string",
"domain": "<Unique ID>.onmicrosoft.com",
"companyName": "NTT Communications Corporation"
},
"billingProfile": 
{"id": "string",
"email": "user@example.com",
"culture": "ja-JP",
"language": "ja",
"companyName": "NTT Communications Corporation",
"defaultAddress": 
{"country": "japan",
"city": "Chiyoda-ku",
"state": "Tokyo",
"addressLine1": "Otemachi 2-3-1",
"addressLine2": "Otemachi Place",
"postalCode": "000-0000",
"firstName": "Taro",
"lastName": "Yamada",
"phoneNumber": "000-0000-0000"
}
}
}

Delete Customer

Authorizations:

TokenAuth

path Parameters

tenant_id

required

string

Responses

204

No Content

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:

TokenAuth

path Parameters

tenant_id

required

string

Request Body schema: application/json

azure_tenant_name required	string <= 128 characters
last_name required	string [ 2 .. 40 ] characters
first_name required	string [ 2 .. 40 ] characters
phone_number required	string <= 64 characters
mailaddress required	string <email> <= 100 characters

Responses

200

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

Payload

Content type

application/json

Copy

Expand all Collapse all


{"azure_tenant_name": "<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."
}

Gdap

Manage Gdaps.

Post Gdap

Authorizations:

TokenAuth

path Parameters

tenant_id

required

string

Responses

200

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}/gdaps

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"displayName": "test",
"approvalUri": "https://admin.microsoft.com/AdminPortal/Home#/partners/invitation/granularAdminRelationships/<GDAP relationship ID>",
"status": "created"
}

Get Gdaps

Authorizations:

TokenAuth

path Parameters

tenant_id

required

string

Responses

200

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.

get/tenants/{tenant_id}/gdaps

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"gdaps": 
[
{"id": "string",
"displayName": "test",
"approvalUri": "https://admin.microsoft.com/AdminPortal/Home#/partners/invitation/granularAdminRelationships/<GDAP relationship ID>",
"approvalDate": "2022-11-18 10:49:10 +0900",
"expirationDate": "2024-11-17 10:54:09 +0900",
"status": "created",
"auto_extend": "active"
}
]
}

Complete Gdap Activation

Authorizations:

TokenAuth

path Parameters

tenant_id required	string
gdap_id required	string

Responses

204

No Content

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.

post/tenants/{tenant_id}/gdaps/{gdap_id}/complete_activation

https://api.ntt.com/ecl-hc-azure/tenants/{tenant_id}/gdaps/{gdap_id}/complete_activation

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"Title": "BadRequest",
"Message": "Bad request."
}

AzurePlan

Manage AzurePlans.

Post AzurePlan

Authorizations:

TokenAuth

path Parameters

tenant_id

required

string

Request Body schema: application/json

account_name

string <= 128 characters

Responses

202

Accepted

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.

post/tenants/{tenant_id}/azure_plan

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

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"account_name": "user@<Unique ID>.onmicrosoft.com"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"Title": "BadRequest",
"Message": "Bad request."
}

Get AzurePlan

Authorizations:

TokenAuth

path Parameters

tenant_id

required

string

Responses

200

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.

get/tenants/{tenant_id}/azure_plan

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"status": "provisioning"
}

Delete AzurePlan

Authorizations:

TokenAuth

path Parameters

tenant_id

required

string

Responses

204

No Content

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.

500

The request has failed due to some unknown error.

delete/tenants/{tenant_id}/azure_plan

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"Title": "BadRequest",
"Message": "Bad request."
}

Subscription

Manage subscriptions.

Get Subscriptions

Authorizations:

TokenAuth

path Parameters

tenant_id

required

string

Responses

200

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


[
{"id": "string",
"tenantId": "string",
"displayName": "test",
"state": "Deleted"
}
]

Suspend Subscription

Authorizations:

TokenAuth

path Parameters

tenant_id required	string
subscription_id required	string

Responses

204

No Content

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:

TokenAuth

path Parameters

tenant_id required	string
subscription_id required	string

Responses

204

No Content

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."
}

Add Subscription

Authorizations:

TokenAuth

path Parameters

tenant_id

required

string

Request Body schema: application/json

account_name required	string <= 128 characters
subscriptionNickName required	string <= 60 characters Subscription name

Responses

202

Accepted

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}/subscription

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

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"account_name": "user@<Unique ID>.onmicrosoft.com",
"subscriptionNickName": "test"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"request": "accepted"
}

Usage

Manage usages.

Get Usage

Authorizations:

TokenAuth

path Parameters

tenant_id

required

string

query Parameters

year required	string Example: year=2021
month required	string Example: month=01

Responses

200

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}/usages

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"Title": "BadRequest",
"Message": "Bad request."
}