Deployments - Create Or Update At Tenant Scope
Implementeert resources op tenantbereik.
U kunt de sjabloon en parameters rechtstreeks in de aanvraag opgeven of een koppeling naar JSON-bestanden maken.
PUT https://management.azure.com/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2021-04-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
deployment
|
path | True |
string minLength: 1maxLength: 64 pattern: ^[-\w\._\(\)]+$ |
De naam van de implementatie. |
api-version
|
query | True |
string |
De API-versie die voor deze bewerking moet worden gebruikt. |
Aanvraagbody
Name | Vereist | Type | Description |
---|---|---|---|
location | True |
string |
De locatie voor het opslaan van de implementatiegegevens. |
properties | True |
De implementatie-eigenschappen. |
|
tags |
object |
Implementatietags |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
OK: retourneert informatie over de implementatie, inclusief de inrichtingsstatus. |
|
201 Created |
Gemaakt: retourneert informatie over de implementatie, inclusief de inrichtingsstatus. |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
Create deployment at tenant scope.
Voorbeeldaanvraag
PUT https://management.azure.com/providers/Microsoft.Resources/deployments/tenant-dep01?api-version=2021-04-01
{
"location": "eastus",
"properties": {
"templateLink": {
"uri": "https://example.com/exampleTemplate.json"
},
"parameters": {},
"mode": "Incremental"
},
"tags": {
"tagKey1": "tag-value-1",
"tagKey2": "tag-value-2"
}
}
Voorbeeldrespons
{
"id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
"name": "tenant-dep01",
"type": "Microsoft.Resources/deployments",
"location": "eastus",
"properties": {
"parameters": {},
"mode": "Incremental",
"provisioningState": "Accepted",
"timestamp": "2019-04-24T22:52:38.7895563Z",
"duration": "PT1.2970875S",
"correlationId": "00000000-0000-0000-0000-000000000000",
"providers": [
{
"namespace": "Microsoft.Authorization",
"resourceTypes": [
{
"resourceType": "policyDefinitions",
"locations": [
null
]
},
{
"resourceType": "policyAssignments",
"locations": [
null
]
}
]
},
{
"namespace": "Microsoft.Resources",
"resourceTypes": [
{
"resourceType": "deployments",
"locations": [
"eastus"
]
}
]
}
],
"dependencies": [
{
"dependsOn": [
{
"id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
"resourceType": "Microsoft.Authorization/policyDefinitions",
"resourceName": "policy-definition-name"
}
],
"id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
"resourceType": "Microsoft.Authorization/policyAssignments",
"resourceName": "location-lock"
}
]
},
"tags": {
"tagKey1": "tag-value-1",
"tagKey2": "tag-value-2"
}
}
{
"id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
"name": "tenant-dep01",
"type": "Microsoft.Resources/deployments",
"location": "eastus",
"properties": {
"parameters": {},
"mode": "Incremental",
"provisioningState": "Accepted",
"timestamp": "2019-04-24T22:52:38.7895563Z",
"duration": "PT1.2970875S",
"correlationId": "00000000-0000-0000-0000-000000000000",
"providers": [
{
"namespace": "Microsoft.Authorization",
"resourceTypes": [
{
"resourceType": "policyDefinitions",
"locations": [
null
]
},
{
"resourceType": "policyAssignments",
"locations": [
null
]
}
]
},
{
"namespace": "Microsoft.Resources",
"resourceTypes": [
{
"resourceType": "deployments",
"locations": [
"eastus"
]
}
]
}
],
"dependencies": [
{
"dependsOn": [
{
"id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
"resourceType": "Microsoft.Authorization/policyDefinitions",
"resourceName": "policy-definition-name"
}
],
"id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
"resourceType": "Microsoft.Authorization/policyAssignments",
"resourceName": "location-lock"
}
]
},
"tags": {
"tagKey1": "tag-value-1",
"tagKey2": "tag-value-2"
}
}
Definities
Name | Description |
---|---|
Alias |
Het aliastype. |
Alias |
Het type paden voor alias. |
Alias |
De kenmerken van het token waarnaar het aliaspad verwijst. |
Alias |
|
Alias |
Het type token waarnaar het aliaspad verwijst. |
Alias |
Het type van het patroon voor een aliaspad. |
Alias |
Het type aliaspatroon |
Alias |
Het type alias. |
Api |
|
Basic |
Informatie over implementatieafhankelijkheid. |
Cloud |
Een foutbericht voor een aanvraag voor resourcebeheer. |
Debug |
De instelling voor foutopsporing. |
Dependency |
Informatie over implementatieafhankelijkheid. |
Deployment |
Implementatiegegevens. |
Deployment |
De modus die wordt gebruikt voor het implementeren van resources. Deze waarde kan incrementeel of voltooid zijn. In de incrementele modus worden resources geïmplementeerd zonder bestaande resources te verwijderen die niet zijn opgenomen in de sjabloon. In de volledige modus worden resources geïmplementeerd en worden bestaande resources in de resourcegroep verwijderd die niet zijn opgenomen in de sjabloon. Wees voorzichtig bij het gebruik van de volledige modus, omdat u resources onbedoeld kunt verwijderen. |
Deployment |
Implementatie-eigenschappen. |
Deployment |
Implementatie-eigenschappen met aanvullende informatie. |
Error |
Aanvullende informatie over de resourcebeheerfout. |
Error |
Foutreactie |
Expression |
Hiermee geeft u op of sjabloonexpressies worden geëvalueerd binnen het bereik van de bovenliggende sjabloon of geneste sjabloon. |
Expression |
Het bereik dat moet worden gebruikt voor de evaluatie van parameters, variabelen en functies in een geneste sjabloon. |
On |
Implementatie bij foutgedrag. |
On |
Implementatie van foutgedrag met aanvullende informatie. |
On |
De implementatie op foutgedragstype. Mogelijke waarden zijn LastSuccessful en SpecificDeployment. |
Parameters |
Entiteit die de verwijzing naar de implementatieparameters vertegenwoordigt. |
Provider |
Resourceprovidergegevens. |
Provider |
De autorisatiestatus van de provider. |
Provider |
De uitgebreide locatie van de provider. |
Provider |
Resourcetype dat wordt beheerd door de resourceprovider. |
Provisioning |
Geeft de status van inrichting aan. |
Resource |
Het resource-id-model. |
Scoped |
Implementatiebewerkingsparameters. |
Template |
Entiteit die de verwijzing naar de sjabloon vertegenwoordigt. |
Zone |
Alias
Het aliastype.
Name | Type | Description |
---|---|---|
defaultMetadata |
De standaardaliaspadmetagegevens. Van toepassing op het standaardpad en op een aliaspad dat geen metagegevens bevat |
|
defaultPath |
string |
Het standaardpad voor een alias. |
defaultPattern |
Het standaardpatroon voor een alias. |
|
name |
string |
De aliasnaam. |
paths |
De paden voor een alias. |
|
type |
Het type alias. |
AliasPath
Het type paden voor alias.
Name | Type | Description |
---|---|---|
apiVersions |
string[] |
De API-versies. |
metadata |
De metagegevens van het aliaspad. Als dit ontbreekt, moet u terugvallen op de standaardmetagegevens van de alias. |
|
path |
string |
Het pad van een alias. |
pattern |
Het patroon voor een aliaspad. |
AliasPathAttributes
De kenmerken van het token waarnaar het aliaspad verwijst.
Waarde | Description |
---|---|
Modifiable |
Het token waarnaar het aliaspad verwijst, kan worden gewijzigd door beleid met het effect Wijzigen. |
None |
Het token waarnaar het aliaspad verwijst, heeft geen kenmerken. |
AliasPathMetadata
Name | Type | Description |
---|---|---|
attributes |
De kenmerken van het token waarnaar het aliaspad verwijst. |
|
type |
Het type token waarnaar het aliaspad verwijst. |
AliasPathTokenType
Het type token waarnaar het aliaspad verwijst.
Waarde | Description |
---|---|
Any |
Het tokentype kan van alles zijn. |
Array |
Het tokentype is matrix. |
Boolean |
Het tokentype is booleaanse waarde. |
Integer |
Het tokentype is een geheel getal. |
NotSpecified |
Het tokentype is niet opgegeven. |
Number |
Het tokentype is getal. |
Object |
Het tokentype is object. |
String |
Het tokentype is een tekenreeks. |
AliasPattern
Het type van het patroon voor een aliaspad.
Name | Type | Description |
---|---|---|
phrase |
string |
De aliaspatroonzin. |
type |
Het type aliaspatroon |
|
variable |
string |
De aliaspatroonvariabele. |
AliasPatternType
Het type aliaspatroon
Waarde | Description |
---|---|
Extract |
Extraheren is de enige toegestane waarde. |
NotSpecified |
NotSpecified is niet toegestaan. |
AliasType
Het type alias.
Waarde | Description |
---|---|
Mask |
Aliaswaarde is geheim. |
NotSpecified |
Aliastype is onbekend (hetzelfde als het instellen van aliastype). |
PlainText |
Aliaswaarde is niet geheim. |
ApiProfile
Name | Type | Description |
---|---|---|
apiVersion |
string |
De API-versie. |
profileVersion |
string |
De profielversie. |
BasicDependency
Informatie over implementatieafhankelijkheid.
Name | Type | Description |
---|---|---|
id |
string |
De id van de afhankelijkheid. |
resourceName |
string |
De naam van de afhankelijkheidsresource. |
resourceType |
string |
Het resourcetype voor afhankelijkheden. |
CloudError
Een foutbericht voor een aanvraag voor resourcebeheer.
Name | Type | Description |
---|---|---|
error |
Foutreactie |
DebugSetting
De instelling voor foutopsporing.
Name | Type | Description |
---|---|---|
detailLevel |
string |
Hiermee geeft u het type informatie op dat moet worden vastgelegd voor foutopsporing. De toegestane waarden zijn geen, requestContent, responseContent of zowel requestContent als responseContent, gescheiden door een komma. De standaardwaarde is geen. Houd bij het instellen van deze waarde zorgvuldig rekening met het type informatie dat u tijdens de implementatie doorgeeft. Door informatie over de aanvraag of het antwoord te registreren, kunt u mogelijk gevoelige gegevens beschikbaar maken die worden opgehaald via de implementatiebewerkingen. |
Dependency
Informatie over implementatieafhankelijkheid.
Name | Type | Description |
---|---|---|
dependsOn |
De lijst met afhankelijkheden. |
|
id |
string |
De id van de afhankelijkheid. |
resourceName |
string |
De naam van de afhankelijkheidsresource. |
resourceType |
string |
Het resourcetype voor afhankelijkheden. |
DeploymentExtended
Implementatiegegevens.
Name | Type | Description |
---|---|---|
id |
string |
De id van de implementatie. |
location |
string |
de locatie van de implementatie. |
name |
string |
De naam van de implementatie. |
properties |
Implementatie-eigenschappen. |
|
tags |
object |
Implementatietags |
type |
string |
Het type implementatie. |
DeploymentMode
De modus die wordt gebruikt voor het implementeren van resources. Deze waarde kan incrementeel of voltooid zijn. In de incrementele modus worden resources geïmplementeerd zonder bestaande resources te verwijderen die niet zijn opgenomen in de sjabloon. In de volledige modus worden resources geïmplementeerd en worden bestaande resources in de resourcegroep verwijderd die niet zijn opgenomen in de sjabloon. Wees voorzichtig bij het gebruik van de volledige modus, omdat u resources onbedoeld kunt verwijderen.
Waarde | Description |
---|---|
Complete | |
Incremental |
DeploymentProperties
Implementatie-eigenschappen.
Name | Type | Description |
---|---|---|
debugSetting |
De foutopsporingsinstelling van de implementatie. |
|
expressionEvaluationOptions |
Hiermee geeft u op of sjabloonexpressies worden geëvalueerd binnen het bereik van de bovenliggende sjabloon of geneste sjabloon. Alleen van toepassing op geneste sjablonen. Als dit niet is opgegeven, is de standaardwaarde buitenste waarde. |
|
mode |
De modus die wordt gebruikt voor het implementeren van resources. Deze waarde kan incrementeel of voltooid zijn. In de incrementele modus worden resources geïmplementeerd zonder bestaande resources te verwijderen die niet zijn opgenomen in de sjabloon. In de volledige modus worden resources geïmplementeerd en worden bestaande resources in de resourcegroep verwijderd die niet zijn opgenomen in de sjabloon. Wees voorzichtig bij het gebruik van de volledige modus, omdat u resources onbedoeld kunt verwijderen. |
|
onErrorDeployment |
De implementatie op foutgedrag. |
|
parameters |
object |
Naam- en waardeparen waarmee de implementatieparameters voor de sjabloon worden gedefinieerd. U gebruikt dit element als u de parameterwaarden rechtstreeks in de aanvraag wilt opgeven in plaats van een koppeling te maken naar een bestaand parameterbestand. Gebruik de eigenschap parametersLink of de parametereigenschap, maar niet beide. Dit kan een JObject of een goed opgemaakte JSON-tekenreeks zijn. |
parametersLink |
De URI van het parameterbestand. U gebruikt dit element om een koppeling te maken naar een bestaand parameterbestand. Gebruik de eigenschap parametersLink of de parametereigenschap, maar niet beide. |
|
template |
object |
De sjablooninhoud. U gebruikt dit element als u de syntaxis van de sjabloon rechtstreeks in de aanvraag wilt doorgeven in plaats van een koppeling naar een bestaande sjabloon. Dit kan een JObject of een goed opgemaakte JSON-tekenreeks zijn. Gebruik de eigenschap templateLink of de sjablooneigenschap, maar niet beide. |
templateLink |
De URI van de sjabloon. Gebruik de eigenschap templateLink of de sjablooneigenschap, maar niet beide. |
DeploymentPropertiesExtended
Implementatie-eigenschappen met aanvullende informatie.
Name | Type | Description |
---|---|---|
correlationId |
string |
De correlatie-id van de implementatie. |
debugSetting |
De foutopsporingsinstelling van de implementatie. |
|
dependencies |
De lijst met implementatieafhankelijkheden. |
|
duration |
string |
De duur van de sjabloonimplementatie. |
error |
Foutreactie |
|
mode |
De implementatiemodus. Mogelijke waarden zijn Incrementeel en Voltooid. |
|
onErrorDeployment |
De implementatie op foutgedrag. |
|
outputResources |
Matrix van ingerichte resources. |
|
outputs |
object |
Sleutel-/waardeparen die de uitvoer van de implementatie vertegenwoordigen. |
parameters |
object |
Implementatieparameters. |
parametersLink |
De URI die verwijst naar de parameters. |
|
providers |
Provider[] |
De lijst met resourceproviders die nodig zijn voor de implementatie. |
provisioningState |
Geeft de status van inrichting aan. |
|
templateHash |
string |
De hash die voor de sjabloon is geproduceerd. |
templateLink |
De URI die verwijst naar de sjabloon. |
|
timestamp |
string (date-time) |
De tijdstempel van de sjabloonimplementatie. |
validatedResources |
Matrix van gevalideerde resources. |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
Name | Type | Description |
---|---|---|
info |
object |
De aanvullende informatie. |
type |
string |
Het extra informatietype. |
ErrorResponse
Foutreactie
Name | Type | Description |
---|---|---|
additionalInfo |
De fout bevat aanvullende informatie. |
|
code |
string |
De foutcode. |
details |
De foutdetails. |
|
message |
string |
Het foutbericht. |
target |
string |
Het foutdoel. |
ExpressionEvaluationOptions
Hiermee geeft u op of sjabloonexpressies worden geëvalueerd binnen het bereik van de bovenliggende sjabloon of geneste sjabloon.
Name | Type | Description |
---|---|---|
scope |
Het bereik dat moet worden gebruikt voor de evaluatie van parameters, variabelen en functies in een geneste sjabloon. |
ExpressionEvaluationOptionsScopeType
Het bereik dat moet worden gebruikt voor de evaluatie van parameters, variabelen en functies in een geneste sjabloon.
Waarde | Description |
---|---|
Inner | |
NotSpecified | |
Outer |
OnErrorDeployment
Implementatie bij foutgedrag.
Name | Type | Description |
---|---|---|
deploymentName |
string |
De implementatie die moet worden gebruikt voor een foutcase. |
type |
De implementatie op foutgedragstype. Mogelijke waarden zijn LastSuccessful en SpecificDeployment. |
OnErrorDeploymentExtended
Implementatie van foutgedrag met aanvullende informatie.
Name | Type | Description |
---|---|---|
deploymentName |
string |
De implementatie die moet worden gebruikt voor een foutcase. |
provisioningState |
string |
De status van de inrichting voor de on-foutimplementatie. |
type |
De implementatie op foutgedragstype. Mogelijke waarden zijn LastSuccessful en SpecificDeployment. |
OnErrorDeploymentType
De implementatie op foutgedragstype. Mogelijke waarden zijn LastSuccessful en SpecificDeployment.
Waarde | Description |
---|---|
LastSuccessful | |
SpecificDeployment |
ParametersLink
Entiteit die de verwijzing naar de implementatieparameters vertegenwoordigt.
Name | Type | Description |
---|---|---|
contentVersion |
string |
Indien opgenomen, moet deze overeenkomen met de ContentVersion in de sjabloon. |
uri |
string |
De URI van het parameterbestand. |
Provider
Resourceprovidergegevens.
Name | Type | Description |
---|---|---|
id |
string |
De provider-id. |
namespace |
string |
De naamruimte van de resourceprovider. |
providerAuthorizationConsentState |
De autorisatiestatus van de provider. |
|
registrationPolicy |
string |
Het registratiebeleid van de resourceprovider. |
registrationState |
string |
De registratiestatus van de resourceprovider. |
resourceTypes |
De verzameling providerresourcetypen. |
ProviderAuthorizationConsentState
De autorisatiestatus van de provider.
Waarde | Description |
---|---|
Consented | |
NotRequired | |
NotSpecified | |
Required |
ProviderExtendedLocation
De uitgebreide locatie van de provider.
Name | Type | Description |
---|---|---|
extendedLocations |
string[] |
De uitgebreide locaties voor de Azure-locatie. |
location |
string |
De azure-locatie. |
type |
string |
Het uitgebreide locatietype. |
ProviderResourceType
Resourcetype dat wordt beheerd door de resourceprovider.
Name | Type | Description |
---|---|---|
aliases |
Alias[] |
De aliassen die worden ondersteund door dit resourcetype. |
apiProfiles |
De API-profielen voor de resourceprovider. |
|
apiVersions |
string[] |
De API-versie. |
capabilities |
string |
De extra mogelijkheden die door dit resourcetype worden aangeboden. |
defaultApiVersion |
string |
De standaard-API-versie. |
locationMappings |
De locatietoewijzingen die worden ondersteund door dit resourcetype. |
|
locations |
string[] |
De verzameling locaties waar dit resourcetype kan worden gemaakt. |
properties |
object |
De eigenschappen. |
resourceType |
string |
Het resourcetype. |
zoneMappings |
ProvisioningState
Geeft de status van inrichting aan.
Waarde | Description |
---|---|
Accepted | |
Canceled | |
Created | |
Creating | |
Deleted | |
Deleting | |
Failed | |
NotSpecified | |
Ready | |
Running | |
Succeeded | |
Updating |
ResourceReference
Het resource-id-model.
Name | Type | Description |
---|---|---|
id |
string |
De volledig gekwalificeerde resource-id. |
ScopedDeployment
Implementatiebewerkingsparameters.
Name | Type | Description |
---|---|---|
location |
string |
De locatie voor het opslaan van de implementatiegegevens. |
properties |
De implementatie-eigenschappen. |
|
tags |
object |
Implementatietags |
TemplateLink
Entiteit die de verwijzing naar de sjabloon vertegenwoordigt.
Name | Type | Description |
---|---|---|
contentVersion |
string |
Indien opgenomen, moet deze overeenkomen met de ContentVersion in de sjabloon. |
id |
string |
De resource-id van een sjabloonspecificatie. Gebruik de id of URI-eigenschap, maar niet beide. |
queryString |
string |
De querytekenreeks (bijvoorbeeld een SAS-token) die moet worden gebruikt met de templateLink-URI. |
relativePath |
string |
De relatievePath-eigenschap kan worden gebruikt om een gekoppelde sjabloon te implementeren op een locatie ten opzichte van het bovenliggende item. Als de bovenliggende sjabloon is gekoppeld aan een TemplateSpec, verwijst dit naar een artefact in de TemplateSpec. Als het bovenliggende item is gekoppeld aan een URI, is de onderliggende implementatie een combinatie van de bovenliggende en relatievePath-URI's |
uri |
string |
De URI van de sjabloon die moet worden geïmplementeerd. Gebruik de eigenschap URI of id, maar niet beide. |
ZoneMapping
Name | Type | Description |
---|---|---|
location |
string |
De locatie van de zonetoewijzing. |
zones |
string[] |