Partilhar via


Organizations - Create

Criar uma organização na aplicação

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

Parâmetros do URI

Name Em Necessário Tipo Description
baseDomain
path True

string

O domínio base para todos os pedidos de serviço do Azure IoT Central.

organizationId
path True

string

ID exclusivo da organização.

Padrão Regex: ^(?!-)[a-z0-9-]{1,48}[a-z0-9]$

subdomain
path True

string

O subdomínio da aplicação.

api-version
query True

string

A versão da API que está a ser chamada.

Corpo do Pedido

Name Tipo Description
displayName

string

Nome a apresentar da organização.

parent

string

ID do encarregado de educação da organização.

Respostas

Name Tipo Description
200 OK

Organization

Com êxito

Other Status Codes

Error

Uma resposta de erro recebida do Serviço Central do IoT.

Cabeçalhos

x-ms-error-code: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

Add or update organization

Pedido de amostra

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

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

Resposta da amostra

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

Definições

Name Description
Error

A definição de erro de resposta.

ErrorDetails

As informações detalhadas do erro.

Organization

A definição da organização.

Error

A definição de erro de resposta.

Name Tipo Description
error

ErrorDetails

Detalhes do erro do pedido atual.

ErrorDetails

As informações detalhadas do erro.

Name Tipo Description
code

string

Código de erro.

message

string

Detalhes da mensagem de erro.

requestId

string

ID de correlação do pedido atual.

time

string

A hora em que o pedido de erro falhou.

Organization

A definição da organização.

Name Tipo Description
displayName

string

Nome a apresentar da organização.

id

string

ID exclusivo da organização.

parent

string

ID do encarregado de educação da organização.