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

Name In Required Type Description
deploymentName
path True
  • string

Nazwa wdrożenia.

Regex pattern: ^[-\w\._\(\)]+$

api-version
query True
  • string

Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Name Required Type Description
location True
  • string

Lokalizacja do przechowywania danych wdrożenia.

properties True

Właściwości wdrożenia.

tags
  • object

Tagi wdrożenia

Odpowiedzi

Name Type Description
200 OK

OK — zwraca informacje o wdrożeniu, w tym o stanie aprowizacji.

201 Created

Utworzono — zwraca informacje o wdrożeniu, w tym o stanie aprowizacji.

Other Status Codes

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation personifikacja konta użytkownika

Przykłady

Create deployment at tenant scope.

Sample Request

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"
  }
}

Sample Response

{
  "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

Alias

Typ aliasu.

AliasPath

Typ ścieżek dla aliasu.

AliasPathAttributes

Atrybuty tokenu, do którego odwołuje się ścieżka aliasu.

AliasPathMetadata
AliasPathTokenType

Typ tokenu, do którego odwołuje się ścieżka aliasu.

AliasPattern

Typ wzorca dla ścieżki aliasu.

AliasPatternType

Typ wzorca aliasu

AliasType

Typ aliasu.

ApiProfile
BasicDependency

Informacje o zależnościach wdrożenia.

CloudError

Odpowiedź na błąd żądania zarządzania zasobami.

DebugSetting

Ustawienie debugowania.

Dependency

Informacje o zależnościach wdrożenia.

DeploymentExtended

Informacje o wdrożeniu.

DeploymentMode

Tryb używany do wdrażania zasobów. Może to być wartość przyrostowa lub kompletna. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie pełnym 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 pełnego, ponieważ możesz przypadkowo usunąć zasoby.

DeploymentProperties

Właściwości wdrożenia.

DeploymentPropertiesExtended

Właściwości wdrożenia z dodatkowymi szczegółami.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorResponse

Odpowiedź na błąd

ExpressionEvaluationOptions

Określa, czy wyrażenia szablonu są oceniane w zakresie szablonu nadrzędnego, czy szablonu zagnieżdżonego.

ExpressionEvaluationOptionsScopeType

Zakres, który ma być używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym.

OnErrorDeployment

Wdrażanie przy zachowaniu błędów.

OnErrorDeploymentExtended

Wdrażanie w przypadku zachowania błędu z dodatkowymi szczegółami.

OnErrorDeploymentType

Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment.

ParametersLink

Jednostka reprezentująca odwołanie do parametrów wdrożenia.

Provider

Informacje o dostawcy zasobów.

ProviderAuthorizationConsentState

Stan zgody autoryzacji dostawcy.

ProviderExtendedLocation

Lokalizacja rozszerzona dostawcy.

ProviderResourceType

Typ zasobu zarządzany przez dostawcę zasobów.

ProvisioningState

Określa stan aprowizacji.

ResourceReference

Model identyfikatora zasobu.

ScopedDeployment

Parametry operacji wdrażania.

TemplateLink

Jednostka reprezentująca odwołanie do szablonu.

ZoneMapping

Alias

Typ aliasu.

Name Type Description
defaultMetadata

Domyślne metadane ścieżki aliasu. Dotyczy ścieżki domyślnej i ś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.

Name Type Description
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.

Name Type Description
Modifiable
  • string

Token, do którego odwołuje się ścieżka aliasu, można modyfikować przez zasady z efektem "modyfikuj".

None
  • string

Token, do którego odwołuje się ścieżka aliasu, nie ma atrybutów.

AliasPathMetadata

Name Type Description
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.

Name Type Description
Any
  • string

Typ tokenu może być dowolny.

Array
  • string

Typ tokenu to tablica.

Boolean
  • string

Typ tokenu to wartość logiczna.

Integer
  • string

Typ tokenu to liczba całkowita.

NotSpecified
  • string

Nie określono typu tokenu.

Number
  • string

Typ tokenu to liczba.

Object
  • string

Typ tokenu to obiekt.

String
  • string

Typ tokenu to ciąg.

AliasPattern

Typ wzorca dla ścieżki aliasu.

Name Type Description
phrase
  • string

Fraza wzorca aliasu.

type

Typ wzorca aliasu

variable
  • string

Zmienna wzorca aliasu.

AliasPatternType

Typ wzorca aliasu

Name Type Description
Extract
  • string

Wyodrębnianie jest jedyną dozwoloną wartością.

NotSpecified
  • string

Pozycja NotSpecified jest niedozwolona.

AliasType

Typ aliasu.

Name Type Description
Mask
  • string

Wartość aliasu jest wpisem tajnym.

NotSpecified
  • string

Typ aliasu jest nieznany (taki sam jak typ aliasu).

PlainText
  • string

Wartość aliasu nie jest wpisem tajnym.

ApiProfile

Name Type Description
apiVersion
  • string

Wersja interfejsu API.

profileVersion
  • string

Wersja profilu.

BasicDependency

Informacje o zależnościach wdrożenia.

Name Type Description
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.

Name Type Description
error

Odpowiedź na błąd
Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

DebugSetting

Ustawienie debugowania.

Name Type Description
detailLevel
  • string

Określa typ informacji do rejestrowania na potrzeby debugowania. Dozwolone wartości to brak, requestContent, responseContent lub zarówno requestContent, jak i responseContent oddzielone przecinkiem. 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.

Name Type Description
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.

Name Type Description
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. Może to być wartość przyrostowa lub kompletna. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie pełnym 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 pełnego, ponieważ możesz przypadkowo usunąć zasoby.

Name Type Description
Complete
  • string
Incremental
  • string

DeploymentProperties

Właściwości wdrożenia.

Name Type Description
debugSetting

Ustawienie debugowania wdrożenia.

expressionEvaluationOptions

Określa, czy wyrażenia szablonu są oceniane w zakresie szablonu nadrzędnego, czy 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. Może to być wartość przyrostowa lub kompletna. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie pełnym 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 pełnego, ponieważ możesz przypadkowo usunąć zasoby.

onErrorDeployment

Wdrożenie w przypadku zachowania błędów.

parameters
  • object

Pary nazw i wartości definiujące parametry wdrożenia dla szablonu. Tego elementu należy użyć, jeśli 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ć 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.

Name Type Description
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
Błąd wdrożenia.

mode

Tryb wdrażania. Możliwe wartości to Przyrostowe i Ukończone.

onErrorDeployment

Wdrożenie w przypadku zachowania błędów.

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

Lista dostawców zasobów potrzebnych 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

Sygnatura czasowa wdrożenia szablonu.

validatedResources

Tablica zweryfikowanych zasobów.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Name Type Description
info
  • object

Dodatkowe informacje.

type
  • string

Dodatkowy typ informacji.

ErrorResponse

Odpowiedź na błąd

Name Type Description
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, czy szablonu zagnieżdżonego.

Name Type Description
scope

Zakres, który ma być używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym.

ExpressionEvaluationOptionsScopeType

Zakres, który ma być używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym.

Name Type Description
Inner
  • string
NotSpecified
  • string
Outer
  • string

OnErrorDeployment

Wdrażanie przy zachowaniu błędów.

Name Type Description
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

Wdrażanie w przypadku zachowania błędu z dodatkowymi szczegółami.

Name Type Description
deploymentName
  • string

Wdrożenie do użycia 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.

Name Type Description
LastSuccessful
  • string
SpecificDeployment
  • string

Jednostka reprezentująca odwołanie do parametrów wdrożenia.

Name Type Description
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.

Name Type Description
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.

Name Type Description
Consented
  • string
NotRequired
  • string
NotSpecified
  • string
Required
  • string

ProviderExtendedLocation

Lokalizacja rozszerzona dostawcy.

Name Type Description
extendedLocations
  • string[]

Rozszerzone lokalizacje dla lokalizacji platformy Azure.

location
  • string

Lokalizacja platformy Azure.

type
  • string

Typ lokalizacji rozszerzonej.

ProviderResourceType

Typ zasobu zarządzany przez dostawcę zasobów.

Name Type Description
aliases

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.

Name Type Description
Accepted
  • string
Canceled
  • string
Created
  • string
Creating
  • string
Deleted
  • string
Deleting
  • string
Failed
  • string
NotSpecified
  • string
Ready
  • string
Running
  • string
Succeeded
  • string
Updating
  • string

ResourceReference

Model identyfikatora zasobu.

Name Type Description
id
  • string

W pełni kwalifikowany identyfikator zasobu.

ScopedDeployment

Parametry operacji wdrażania.

Name Type Description
location
  • string

Lokalizacja do przechowywania danych wdrożenia.

properties

Właściwości wdrożenia.

tags
  • object

Tagi wdrożenia

Jednostka reprezentująca odwołanie do szablonu.

Name Type Description
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 id lub uri, ale nie obu.

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, spowoduje to odwołanie 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 relativePath

uri
  • string

Identyfikator URI szablonu do wdrożenia. Użyj właściwości URI lub id, ale nie obu.

ZoneMapping

Name Type Description
location
  • string

Lokalizacja mapowania strefy.

zones
  • string[]