Deployments - Create Or Update At Tenant Scope
Wdraża zasoby w zakresie dzierżawy.
Szablon i parametry można podać bezpośrednio w żądaniu lub połączyć z plikami JSON.
PUT https://management.azure.com/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2021-04-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
deployment
|
path | True |
string minLength: 1maxLength: 64 pattern: ^[-\w\._\(\)]+$ |
Nazwa wdrożenia. |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia dla tej operacji. |
Treść żądania
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
location | True |
string |
Lokalizacja do przechowywania danych wdrożenia. |
properties | True |
Właściwości wdrożenia. |
|
tags |
object |
Tagi wdrożenia |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK — zwraca informacje o wdrożeniu, w tym o stanie aprowizacji. |
|
201 Created |
Utworzono — zwraca informacje o wdrożeniu, w tym stan aprowizacji. |
|
Other Status Codes |
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. |
Zabezpieczenia
azure_auth
Przepływ protokołu OAuth2 usługi Azure Active Directory
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
Create deployment at tenant scope.
Przykładowe żądanie
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"
}
}
Przykładowa odpowiedź
{
"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"
}
}
Definicje
Nazwa | Opis |
---|---|
Alias |
Typ aliasu. |
Alias |
Typ ścieżek dla aliasu. |
Alias |
Atrybuty tokenu, do którego odwołuje się ścieżka aliasu. |
Alias |
|
Alias |
Typ tokenu, do którego odwołuje się ścieżka aliasu. |
Alias |
Typ wzorca dla ścieżki aliasu. |
Alias |
Typ wzorca aliasu |
Alias |
Typ aliasu. |
Api |
|
Basic |
Informacje o zależnościach wdrożenia. |
Cloud |
Odpowiedź na błąd żądania zarządzania zasobami. |
Debug |
Ustawienie debugowania. |
Dependency |
Informacje o zależnościach wdrożenia. |
Deployment |
Informacje o wdrożeniu. |
Deployment |
Tryb używany do wdrażania zasobów. Ta wartość może być przyrostowa lub ukończona. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie kompletnym zasoby są wdrażane, a istniejące zasoby w grupie zasobów, które nie są uwzględnione w szablonie, są usuwane. Należy zachować ostrożność podczas korzystania z trybu ukończenia, ponieważ możesz przypadkowo usunąć zasoby. |
Deployment |
Właściwości wdrożenia. |
Deployment |
Właściwości wdrożenia z dodatkowymi szczegółami. |
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
Error |
Odpowiedź na błąd |
Expression |
Określa, czy wyrażenia szablonu są oceniane w zakresie szablonu nadrzędnego lub szablonu zagnieżdżonego. |
Expression |
Zakres używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym. |
On |
Wdrażanie przy zachowaniu błędu. |
On |
Wdrożenie dotyczące zachowania błędu z dodatkowymi szczegółami. |
On |
Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment. |
Parameters |
Jednostka reprezentująca odwołanie do parametrów wdrożenia. |
Provider |
Informacje o dostawcy zasobów. |
Provider |
Stan zgody autoryzacji dostawcy. |
Provider |
Lokalizacja rozszerzona dostawcy. |
Provider |
Typ zasobu zarządzany przez dostawcę zasobów. |
Provisioning |
Określa stan aprowizacji. |
Resource |
Model identyfikatora zasobu. |
Scoped |
Parametry operacji wdrażania. |
Template |
Jednostka reprezentująca odwołanie do szablonu. |
Zone |
Alias
Typ aliasu.
Nazwa | Typ | Opis |
---|---|---|
defaultMetadata |
Domyślne metadane ścieżki aliasu. Dotyczy ścieżki domyślnej i do dowolnej ścieżki aliasu, która nie ma metadanych |
|
defaultPath |
string |
Domyślna ścieżka aliasu. |
defaultPattern |
Domyślny wzorzec aliasu. |
|
name |
string |
Nazwa aliasu. |
paths |
Ścieżki aliasu. |
|
type |
Typ aliasu. |
AliasPath
Typ ścieżek dla aliasu.
Nazwa | Typ | Opis |
---|---|---|
apiVersions |
string[] |
Wersje interfejsu API. |
metadata |
Metadane ścieżki aliasu. Jeśli brakuje, wróć do domyślnych metadanych aliasu. |
|
path |
string |
Ścieżka aliasu. |
pattern |
Wzorzec ścieżki aliasu. |
AliasPathAttributes
Atrybuty tokenu, do którego odwołuje się ścieżka aliasu.
Wartość | Opis |
---|---|
Modifiable |
Token, do którego odwołuje się ścieżka aliasu, można modyfikować przez zasady z efektem "modyfikuj". |
None |
Token, do którego odwołuje się ścieżka aliasu, nie ma atrybutów. |
AliasPathMetadata
Nazwa | Typ | Opis |
---|---|---|
attributes |
Atrybuty tokenu, do którego odwołuje się ścieżka aliasu. |
|
type |
Typ tokenu, do którego odwołuje się ścieżka aliasu. |
AliasPathTokenType
Typ tokenu, do którego odwołuje się ścieżka aliasu.
Wartość | Opis |
---|---|
Any |
Typ tokenu może być dowolny. |
Array |
Typ tokenu to tablica. |
Boolean |
Typ tokenu to wartość logiczna. |
Integer |
Typ tokenu to liczba całkowita. |
NotSpecified |
Nie określono typu tokenu. |
Number |
Typ tokenu to liczba. |
Object |
Typ tokenu to obiekt. |
String |
Typ tokenu to ciąg. |
AliasPattern
Typ wzorca dla ścieżki aliasu.
Nazwa | Typ | Opis |
---|---|---|
phrase |
string |
Fraza wzorca aliasu. |
type |
Typ wzorca aliasu |
|
variable |
string |
Zmienna wzorca aliasu. |
AliasPatternType
Typ wzorca aliasu
Wartość | Opis |
---|---|
Extract |
Wyodrębnianie jest jedyną dozwoloną wartością. |
NotSpecified |
Powiadomienie nie jest dozwolone. |
AliasType
Typ aliasu.
Wartość | Opis |
---|---|
Mask |
Wartość aliasu jest wpisem tajnym. |
NotSpecified |
Typ aliasu jest nieznany (taki sam jak typ aliasu). |
PlainText |
Wartość aliasu nie jest wpisem tajnym. |
ApiProfile
Nazwa | Typ | Opis |
---|---|---|
apiVersion |
string |
Wersja interfejsu API. |
profileVersion |
string |
Wersja profilu. |
BasicDependency
Informacje o zależnościach wdrożenia.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator zależności. |
resourceName |
string |
Nazwa zasobu zależności. |
resourceType |
string |
Typ zasobu zależności. |
CloudError
Odpowiedź na błąd żądania zarządzania zasobami.
Nazwa | Typ | Opis |
---|---|---|
error |
Odpowiedź na błąd |
DebugSetting
Ustawienie debugowania.
Nazwa | Typ | Opis |
---|---|---|
detailLevel |
string |
Określa typ informacji do rejestrowania na potrzeby debugowania. Dozwolone wartości to none, requestContent, responseContent lub requestContent i responseContent oddzielone przecinkami. Wartość domyślna to brak. Podczas ustawiania tej wartości należy dokładnie rozważyć typ informacji przekazywanych podczas wdrażania. Rejestrując informacje o żądaniu lub odpowiedzi, możesz potencjalnie uwidocznić poufne dane pobierane za pośrednictwem operacji wdrażania. |
Dependency
Informacje o zależnościach wdrożenia.
Nazwa | Typ | Opis |
---|---|---|
dependsOn |
Lista zależności. |
|
id |
string |
Identyfikator zależności. |
resourceName |
string |
Nazwa zasobu zależności. |
resourceType |
string |
Typ zasobu zależności. |
DeploymentExtended
Informacje o wdrożeniu.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator wdrożenia. |
location |
string |
lokalizacja wdrożenia. |
name |
string |
Nazwa wdrożenia. |
properties |
Właściwości wdrożenia. |
|
tags |
object |
Tagi wdrożenia |
type |
string |
Typ wdrożenia. |
DeploymentMode
Tryb używany do wdrażania zasobów. Ta wartość może być przyrostowa lub ukończona. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie kompletnym zasoby są wdrażane, a istniejące zasoby w grupie zasobów, które nie są uwzględnione w szablonie, są usuwane. Należy zachować ostrożność podczas korzystania z trybu ukończenia, ponieważ możesz przypadkowo usunąć zasoby.
Wartość | Opis |
---|---|
Complete | |
Incremental |
DeploymentProperties
Właściwości wdrożenia.
Nazwa | Typ | Opis |
---|---|---|
debugSetting |
Ustawienie debugowania wdrożenia. |
|
expressionEvaluationOptions |
Określa, czy wyrażenia szablonu są oceniane w zakresie szablonu nadrzędnego lub szablonu zagnieżdżonego. Dotyczy tylko szablonów zagnieżdżonych. Jeśli nie zostanie określony, wartość domyślna jest zewnętrzna. |
|
mode |
Tryb używany do wdrażania zasobów. Ta wartość może być przyrostowa lub ukończona. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie kompletnym zasoby są wdrażane, a istniejące zasoby w grupie zasobów, które nie są uwzględnione w szablonie, są usuwane. Należy zachować ostrożność podczas korzystania z trybu ukończenia, ponieważ możesz przypadkowo usunąć zasoby. |
|
onErrorDeployment |
Wdrożenie w przypadku zachowania błędu. |
|
parameters |
object |
Pary nazw i wartości definiujące parametry wdrożenia dla szablonu. Ten element jest używany, gdy chcesz podać wartości parametrów bezpośrednio w żądaniu, a nie połączyć się z istniejącym plikiem parametrów. Użyj właściwości parametersLink lub właściwości parameters, ale nie obu. Może to być ciąg JObject lub dobrze sformułowany ciąg JSON. |
parametersLink |
Identyfikator URI pliku parametrów. Ten element służy do łączenia z istniejącym plikiem parametrów. Użyj właściwości parametersLink lub właściwości parameters, ale nie obu. |
|
template |
object |
Zawartość szablonu. Ten element jest używany, gdy chcesz przekazać składnię szablonu bezpośrednio w żądaniu, a nie połączyć się z istniejącym szablonem. Może to być ciąg JObject lub dobrze sformułowany ciąg JSON. Użyj właściwości templateLink lub właściwości szablonu, ale nie obu. |
templateLink |
Identyfikator URI szablonu. Użyj właściwości templateLink lub właściwości szablonu, ale nie obu. |
DeploymentPropertiesExtended
Właściwości wdrożenia z dodatkowymi szczegółami.
Nazwa | Typ | Opis |
---|---|---|
correlationId |
string |
Identyfikator korelacji wdrożenia. |
debugSetting |
Ustawienie debugowania wdrożenia. |
|
dependencies |
Lista zależności wdrożenia. |
|
duration |
string |
Czas trwania wdrożenia szablonu. |
error |
Odpowiedź na błąd |
|
mode |
Tryb wdrażania. Możliwe wartości to Przyrostowe i Ukończone. |
|
onErrorDeployment |
Wdrożenie w przypadku zachowania błędu. |
|
outputResources |
Tablica zaaprowizowanych zasobów. |
|
outputs |
object |
Pary klucz/wartość reprezentujące dane wyjściowe wdrożenia. |
parameters |
object |
Parametry wdrożenia. |
parametersLink |
Identyfikator URI odwołujące się do parametrów. |
|
providers |
Provider[] |
Lista dostawców zasobów wymaganych do wdrożenia. |
provisioningState |
Określa stan aprowizacji. |
|
templateHash |
string |
Skrót utworzony dla szablonu. |
templateLink |
Identyfikator URI odwołujące się do szablonu. |
|
timestamp |
string (date-time) |
Sygnatura czasowa wdrożenia szablonu. |
validatedResources |
Tablica zweryfikowanych zasobów. |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
Nazwa | Typ | Opis |
---|---|---|
info |
object |
Dodatkowe informacje. |
type |
string |
Dodatkowy typ informacji. |
ErrorResponse
Odpowiedź na błąd
Nazwa | Typ | Opis |
---|---|---|
additionalInfo |
Dodatkowe informacje o błędzie. |
|
code |
string |
Kod błędu. |
details |
Szczegóły błędu. |
|
message |
string |
Komunikat o błędzie. |
target |
string |
Element docelowy błędu. |
ExpressionEvaluationOptions
Określa, czy wyrażenia szablonu są oceniane w zakresie szablonu nadrzędnego lub szablonu zagnieżdżonego.
Nazwa | Typ | Opis |
---|---|---|
scope |
Zakres używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym. |
ExpressionEvaluationOptionsScopeType
Zakres używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym.
Wartość | Opis |
---|---|
Inner | |
NotSpecified | |
Outer |
OnErrorDeployment
Wdrażanie przy zachowaniu błędu.
Nazwa | Typ | Opis |
---|---|---|
deploymentName |
string |
Wdrożenie, które ma być używane w przypadku błędu. |
type |
Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment. |
OnErrorDeploymentExtended
Wdrożenie dotyczące zachowania błędu z dodatkowymi szczegółami.
Nazwa | Typ | Opis |
---|---|---|
deploymentName |
string |
Wdrożenie, które ma być używane w przypadku błędu. |
provisioningState |
string |
Stan aprowizacji wdrożenia w przypadku błędu. |
type |
Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment. |
OnErrorDeploymentType
Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment.
Wartość | Opis |
---|---|
LastSuccessful | |
SpecificDeployment |
ParametersLink
Jednostka reprezentująca odwołanie do parametrów wdrożenia.
Nazwa | Typ | Opis |
---|---|---|
contentVersion |
string |
W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie. |
uri |
string |
Identyfikator URI pliku parametrów. |
Provider
Informacje o dostawcy zasobów.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator dostawcy. |
namespace |
string |
Przestrzeń nazw dostawcy zasobów. |
providerAuthorizationConsentState |
Stan zgody autoryzacji dostawcy. |
|
registrationPolicy |
string |
Zasady rejestracji dostawcy zasobów. |
registrationState |
string |
Stan rejestracji dostawcy zasobów. |
resourceTypes |
Kolekcja typów zasobów dostawcy. |
ProviderAuthorizationConsentState
Stan zgody autoryzacji dostawcy.
Wartość | Opis |
---|---|
Consented | |
NotRequired | |
NotSpecified | |
Required |
ProviderExtendedLocation
Lokalizacja rozszerzona dostawcy.
Nazwa | Typ | Opis |
---|---|---|
extendedLocations |
string[] |
Rozszerzone lokalizacje lokalizacji platformy Azure. |
location |
string |
Lokalizacja platformy Azure. |
type |
string |
Typ lokalizacji rozszerzonej. |
ProviderResourceType
Typ zasobu zarządzany przez dostawcę zasobów.
Nazwa | Typ | Opis |
---|---|---|
aliases |
Alias[] |
Aliasy obsługiwane przez ten typ zasobu. |
apiProfiles |
Profile interfejsu API dla dostawcy zasobów. |
|
apiVersions |
string[] |
Wersja interfejsu API. |
capabilities |
string |
Dodatkowe możliwości oferowane przez ten typ zasobu. |
defaultApiVersion |
string |
Domyślna wersja interfejsu API. |
locationMappings |
Mapowania lokalizacji obsługiwane przez ten typ zasobu. |
|
locations |
string[] |
Kolekcja lokalizacji, w których można utworzyć ten typ zasobu. |
properties |
object |
Właściwości. |
resourceType |
string |
Typ zasobu. |
zoneMappings |
ProvisioningState
Określa stan aprowizacji.
Wartość | Opis |
---|---|
Accepted | |
Canceled | |
Created | |
Creating | |
Deleted | |
Deleting | |
Failed | |
NotSpecified | |
Ready | |
Running | |
Succeeded | |
Updating |
ResourceReference
Model identyfikatora zasobu.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
W pełni kwalifikowany identyfikator zasobu. |
ScopedDeployment
Parametry operacji wdrażania.
Nazwa | Typ | Opis |
---|---|---|
location |
string |
Lokalizacja do przechowywania danych wdrożenia. |
properties |
Właściwości wdrożenia. |
|
tags |
object |
Tagi wdrożenia |
TemplateLink
Jednostka reprezentująca odwołanie do szablonu.
Nazwa | Typ | Opis |
---|---|---|
contentVersion |
string |
W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie. |
id |
string |
Identyfikator zasobu specyfikacji szablonu. Użyj właściwości identyfikatora lub identyfikatora URI, ale nie obu tych elementów. |
queryString |
string |
Ciąg zapytania (na przykład token SAS) do użycia z identyfikatorem URI szablonuLink. |
relativePath |
string |
Właściwość relativePath może służyć do wdrażania połączonego szablonu w lokalizacji względem elementu nadrzędnego. Jeśli szablon nadrzędny został połączony z szablonem TemplateSpec, będzie on odwoływać się do artefaktu w elemencie TemplateSpec. Jeśli element nadrzędny został połączony z identyfikatorem URI, wdrożenie podrzędne będzie kombinacją identyfikatorów URI nadrzędnych i względnychPath |
uri |
string |
Identyfikator URI szablonu do wdrożenia. Użyj właściwości URI lub id, ale nie obu. |
ZoneMapping
Nazwa | Typ | Opis |
---|---|---|
location |
string |
Lokalizacja mapowania strefy. |
zones |
string[] |