Organizations - Create

  • リファレンス
サービス:
IoT Central
API バージョン:
2022-07-31

アプリケーションでorganizationを作成する

PUT https://{subdomain}.{baseDomain}/api/organizations/{organizationId}?api-version=2022-07-31

URI パラメーター

名前 / 必須 型 説明
baseDomain
 path True

string

すべての Azure IoT Central サービス要求の基本ドメイン。
organizationId
 path True

string

organizationの一意の ID。

正規表現パターン: ^(?!-)[a-z0-9-]{1,48}[a-z0-9]$
subdomain
 path True

string

アプリケーション サブドメイン。
api-version
 query True

string

呼び出される API のバージョン。

要求本文

名前 型 説明
displayName

string

organizationの表示名。
parent

string

organizationの親の ID。

応答

名前 型 説明
200 OK

Organization

Success
Other Status Codes

Error

IoT Central サービスから受信したエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

例

Add or update organization

要求のサンプル

PUT https://appsubdomain.azureiotcentral.com/api/organizations/seattle?api-version=2022-07-31

{
  "displayName": "Seattle",
  "parent": "washington"
}

応答のサンプル

状態コード:
200 
{
  "id": "seattle",
  "displayName": "Seattle",
  "parent": "washington"
}

定義

名前 説明
Error

応答エラーの定義。
ErrorDetails

エラーの詳細情報。
Organization

organization定義。

Error

応答エラーの定義。

名前 型 説明
error

ErrorDetails

現在の要求のエラーの詳細。

ErrorDetails

エラーの詳細情報。

名前 型 説明
code

string

エラー コード。
message

string

エラー メッセージの詳細。
requestId

string

現在の要求の関連付け ID。
time

string

エラー要求が失敗した時刻。

Organization

organization定義。

名前 型 説明
displayName

string

organizationの表示名。
id

string

organizationの一意の ID。
parent

string

organizationの親の ID。