Deployments - Create Or Update Deployment

Serviço:

Device Update

Versão da API:

2020-09-01

Cria ou atualiza uma implantação.

PUT https://{accountEndpoint}/deviceupdate/{instanceId}/v2/management/deployments/{deploymentId}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
accountEndpoint	path	True	string	Ponto de extremidade da conta.
deploymentId	path	True	string	Identificador de implantação.
instanceId	path	True	string	Identificador da instância da conta.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
deploymentId	True	string	Obtém ou define o identificador de implantação.
deploymentType	True	DeploymentType	Obtém ou define o tipo de implantação.
deviceGroupDefinition	True	string[]	Obtém ou define a definição do grupo de dispositivos.
deviceGroupType	True	DeviceGroupType	Obtém ou define o tipo de grupo de dispositivos.
startDateTime	True	string (date-time)	Obtém ou define a data de início da implantação.
updateId	True	UpdateId	Atualizar identidade.
deviceClassId		string	Obtém ou define o identificador de classe do dispositivo.
isCanceled		boolean	Sinalizador booliano indicando se a implantação foi cancelada.
isCompleted		boolean	Sinalizador booliano que indica se a implantação foi concluída.
isRetried		boolean	Sinalizador booliano que indica se a implantação foi repetida.

Respostas

Nome	Tipo	Description
200 OK	Deployment	As propriedades de implantação.
404 Not Found		Não encontrado.

Segurança

azure_auth_implicit

Fluxo Implícito do OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

azure_auth_code

Fluxo do AccessCode do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
URL do Token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

azure_auth_application

Fluxo de Aplicativos OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: application
URL do Token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Escopos

Nome	Description
.default	escopo da credencial do cliente

azure_auth_password

Fluxo de senha do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: password
URL do Token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Deployments_CreateOrUpdateDeployment

Solicitação de exemplo

HTTP

PUT https://contoso.api.adu.microsoft.com/deviceupdate/blue/v2/management/deployments/deploymentId

{
  "deploymentId": "deploymentId",
  "deploymentType": "Complete",
  "deviceClassId": "31ee8c56559847429fbe86e3e87f99b6",
  "startDateTime": "2020-04-22T12:12:12.0000000+00:00",
  "deviceGroupType": "Devices",
  "deviceGroupDefinition": [
    "device1",
    "device2"
  ],
  "updateId": {
    "provider": "provider",
    "name": "name",
    "version": "1.2.3.4"
  }
}

Resposta de exemplo

Código de status:

200

{
  "deploymentId": "deploymentId",
  "deploymentType": "Complete",
  "deviceClassId": "31ee8c56559847429fbe86e3e87f99b6",
  "startDateTime": "2020-04-22T12:12:12.0000000+00:00",
  "deviceGroupType": "Devices",
  "deviceGroupDefinition": [
    "device1",
    "device2"
  ],
  "updateId": {
    "provider": "provider",
    "name": "name",
    "version": "1.2.3.4"
  }
}

Código de status:

404

Definições

Nome	Description
Deployment	Metadados de implantação.
DeploymentType	Tipos de implantação com suporte.
DeviceGroupType	Tipos de grupo de implantação com suporte.
UpdateId	Identificador de atualização.

Deployment

Objeto

Metadados de implantação.

Nome	Tipo	Description
deploymentId	string	Obtém ou define o identificador de implantação.
deploymentType	DeploymentType	Obtém ou define o tipo de implantação.
deviceClassId	string	Obtém ou define o identificador de classe do dispositivo.
deviceGroupDefinition	string[]	Obtém ou define a definição do grupo de dispositivos.
deviceGroupType	DeviceGroupType	Obtém ou define o tipo de grupo de dispositivos.
isCanceled	boolean	Sinalizador booliano indicando se a implantação foi cancelada.
isCompleted	boolean	Sinalizador booliano que indica se a implantação foi concluída.
isRetried	boolean	Sinalizador booliano que indica se a implantação foi repetida.
startDateTime	string (date-time)	Obtém ou define a data de início da implantação.
updateId	UpdateId	Atualizar identidade.

DeploymentType

Enumeração

Tipos de implantação com suporte.

Valor	Description
Complete	Uma implantação completa, incluindo baixar, instalar e aplicar ações.
Download	Uma implantação somente para download que não inclui nenhuma instalação ou aplicação de ações. Não há suporte atualmente.
Install	Uma distribuição somente instalação que não inclui nenhuma ação de download, apenas instalar e concluir. Não há suporte atualmente.

DeviceGroupType

Enumeração

Tipos de grupo de implantação com suporte.

Valor	Description
All	A implantação deve ser enviada para todos os dispositivos na classe de dispositivo.
Devices	A implantação deve ser enviada para a lista de dispositivos na definição do grupo de dispositivos.
DeviceGroupDefinitions	A implantação deve ser enviada para a lista de dispositivos retornados pela união de todas as consultas de definição do grupo de dispositivos.

UpdateId

Objeto

Identificador de atualização.

Nome	Tipo	Description
name	string	Nome da atualização.
provider	string	Atualizar o provedor.
version	string	Atualizar versão.