Environments - Create Or Update

Služba:

Dev Test Labs

Verze rozhraní API:

2018-09-15

Vytvořte nebo nahraďte existující prostředí. Dokončení této operace může chvíli trvat.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}?api-version=2018-09-15

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
labName	path	True	string	Název testovacího prostředí.
name	path	True	string	Název prostředí.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
userName	path	True	string	Jméno profilu uživatele.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
location	string	Geografická poloha, kde se prostředek nachází
properties.armTemplateDisplayName	string	Zobrazovaný název šablony Azure Resource Manageru, která vytvořila prostředí.
properties.deploymentProperties	EnvironmentDeploymentProperties	Vlastnosti nasazení prostředí.
tags	object	Značky prostředků

Odpovědi

Name	Typ	Description
200 OK	DtlEnvironment	Operace aktualizace prostředku DtlEnvironment byla úspěšná
201 Created	DtlEnvironment	Operace vytvoření prostředku DtlEnvironment byla úspěšná Hlavičky Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Environments_CreateOrUpdate

Ukázkový požadavek

HTTP

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/users/@me/environments/{environmentName}?api-version=2018-09-15

{
  "properties": {
    "deploymentProperties": {
      "armTemplateId": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}",
      "parameters": []
    }
  }
}

Ukázková odpověď

Stavový kód:

200

{
  "name": "{environmentName}",
  "type": "Microsoft.DevTestLab/labs/users/environments",
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/users/{uniqueIdentifier}/environments/{environmentName}",
  "location": "{location}",
  "properties": {
    "createdByUser": "user@contoso.com",
    "deploymentProperties": {
      "armTemplateId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}"
    },
    "provisioningState": "Succeeded",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "tags": {
    "tagName1": "tagValue1"
  }
}

Stavový kód:

201

{
  "name": "{environmentName}",
  "type": "Microsoft.DevTestLab/labs/users/environments",
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/users/{uniqueIdentifier}/environments/{environmentName}",
  "location": "{location}",
  "properties": {
    "createdByUser": "user@contoso.com",
    "deploymentProperties": {
      "armTemplateId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/artifactSources/{artifactSourceName}/armTemplates/{armTemplateName}"
    },
    "provisioningState": "Creating",
    "uniqueIdentifier": "{uniqueIdentifier}"
  },
  "tags": {
    "tagName1": "tagValue1"
  }
}

Definice

Name	Description
ArmTemplateParameterProperties	Vlastnosti parametru šablony Azure Resource Manageru
createdByType	Typ identity, která prostředek vytvořila.
DtlEnvironment	Prostředí, což je v podstatě nasazení šablony ARM.
EnvironmentDeploymentProperties	Vlastnosti nasazení prostředí
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

ArmTemplateParameterProperties

Objekt

Vlastnosti parametru šablony Azure Resource Manageru

Name	Typ	Description
name	string	Název parametru šablony.
value	string	Hodnota parametru šablony.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

DtlEnvironment

Objekt

Prostředí, což je v podstatě nasazení šablony ARM.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Geografická poloha, kde se prostředek nachází
name	string	Název prostředku
properties.armTemplateDisplayName	string	Zobrazovaný název šablony Azure Resource Manageru, která vytvořila prostředí.
properties.createdByUser	string	Tvůrce prostředí.
properties.deploymentProperties	EnvironmentDeploymentProperties	Vlastnosti nasazení prostředí.
properties.provisioningState	string	Stav zřizování prostředku.
properties.resourceGroupId	string	Identifikátor skupiny prostředků obsahující prostředky prostředí.
properties.uniqueIdentifier	string	Jedinečný neměnný identifikátor prostředku (GUID).
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
tags	object	Značky prostředků
type	string	Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts"

EnvironmentDeploymentProperties

Objekt

Vlastnosti nasazení prostředí

Name	Typ	Description
armTemplateId	string	Identifikátor šablony Azure Resource Manageru
parameters	ArmTemplateParameterProperties[]	Parametry šablony Azure Resource Manageru

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.