Deployments - Get

Služba:

Resource Management

Verze rozhraní API:

2025-04-01

Získá nasazení.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2025-04-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
deploymentName	path	True	string minLength: 1 maxLength: 64 pattern: ^[-\w\._\(\)]+$	Název nasazení.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string	ID předplatného Microsoft Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	DeploymentExtended	OK – Vrátí informace o nasazení, včetně stavu zřizování.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

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

Rozsahy

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

Definice

Name	Description
Alias	Typ aliasu.
AliasPath	Typ cest pro alias.
AliasPathAttributes	Atributy tokenu, na který cesta aliasu odkazuje.
AliasPathMetadata
AliasPathTokenType	Typ tokenu, na který cesta aliasu odkazuje.
AliasPattern	Typ vzoru pro cestu aliasu.
AliasPatternType	Typ vzoru aliasu
AliasType	Typ aliasu.
ApiProfile
BasicDependency	Informace o závislostech nasazení
CloudError	Odpověď na chybu žádosti o správu prostředků.
DebugSetting	Nastavení ladění.
Dependency	Informace o závislostech nasazení
DeploymentDiagnosticsDefinition
DeploymentExtended	Informace o nasazení
DeploymentExtensionConfigItem
DeploymentExtensionDefinition
DeploymentMode	Režim, který se používá k nasazení prostředků. Tato hodnota může být přírůstková nebo úplná. V přírůstkovém režimu se prostředky nasazují bez odstranění existujících prostředků, které nejsou součástí šablony. V režimu Dokončení se prostředky nasadí a existující prostředky ve skupině prostředků, které nejsou součástí šablony, se odstraní. Při použití režimu Dokončení buďte opatrní, protože nechtěně odstraňte prostředky.
DeploymentPropertiesExtended	Vlastnosti nasazení s dalšími podrobnostmi
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorResponse	Odpověď na chybu
ExtensionConfigPropertyType
KeyVaultParameterReference	Referenční informace k parametrům služby Azure Key Vault
KeyVaultReference	Referenční informace ke službě Azure Key Vault
Level	Označuje dodatečnou úroveň odezvy.
OnErrorDeploymentExtended	Nasazení při chování chyby s dalšími podrobnostmi
OnErrorDeploymentType	Nasazení typu chování chyby. Možné hodnoty jsou LastSuccessful a SpecificDeployment.
ParametersLink	Entita představující odkaz na parametry nasazení
Provider	Informace o poskytovateli prostředků
ProviderAuthorizationConsentState	Stav souhlasu s autorizací zprostředkovatele.
ProviderExtendedLocation	Rozšířené umístění poskytovatele.
ProviderResourceType	Typ prostředku spravovaný poskytovatelem prostředků
ProvisioningState	Označuje stav zřizování.
ResourceReference	Model ID prostředku.
TemplateLink	Entita představující odkaz na šablonu.
ValidationLevel	Úroveň ověření provedeného při nasazení.
ZoneMapping

Alias

Objekt

Typ aliasu.

Name	Typ	Description
defaultMetadata	AliasPathMetadata	Výchozí metadata cesty aliasu. Platí pro výchozí cestu a pro libovolnou cestu aliasu, která neobsahuje metadata.
defaultPath	string	Výchozí cesta pro alias.
defaultPattern	AliasPattern	Výchozí vzor aliasu.
name	string	Název aliasu.
paths	AliasPath[]	Cesty pro alias.
type	AliasType	Typ aliasu.

AliasPath

Objekt

Typ cest pro alias.

Name	Typ	Description
apiVersions	string[]	Verze rozhraní API.
metadata	AliasPathMetadata	Metadata cesty aliasu. Pokud chybí, vraťte se k výchozím metadatům aliasu.
path	string	Cesta aliasu
pattern	AliasPattern	Vzor cesty aliasu.

AliasPathAttributes

Výčet

Atributy tokenu, na který cesta aliasu odkazuje.

Hodnota	Description
None	Token, na který cesta aliasu odkazuje, nemá žádné atributy.
Modifiable	Token, na který cesta aliasu odkazuje, je možné upravit zásadami s účinkem "modify".

AliasPathMetadata

Objekt

Name	Typ	Description
attributes	AliasPathAttributes	Atributy tokenu, na který cesta aliasu odkazuje.
type	AliasPathTokenType	Typ tokenu, na který cesta aliasu odkazuje.

AliasPathTokenType

Výčet

Typ tokenu, na který cesta aliasu odkazuje.

Hodnota	Description
NotSpecified	Typ tokenu není zadán.
Any	Typ tokenu může být cokoli.
String	Typ tokenu je řetězec.
Object	Typ tokenu je objekt.
Array	Typ tokenu je pole.
Integer	Typ tokenu je celé číslo.
Number	Typ tokenu je číslo.
Boolean	Typ tokenu je logický.

AliasPattern

Objekt

Typ vzoru pro cestu aliasu.

Name	Typ	Description
phrase	string	Fráze vzoru aliasu.
type	AliasPatternType	Typ vzoru aliasu
variable	string	Proměnná vzoru aliasu.

AliasPatternType

Výčet

Typ vzoru aliasu

Hodnota	Description
NotSpecified	Není zadáno.
Extract	Extrahování je jediná povolená hodnota.

AliasType

Výčet

Typ aliasu.

Hodnota	Description
NotSpecified	Typ aliasu je neznámý (stejný jako typ aliasu).
PlainText	Hodnota aliasu není tajná.
Mask	Hodnota aliasu je tajný klíč.

ApiProfile

Objekt

Name	Typ	Description
apiVersion	string	Verze rozhraní API.
profileVersion	string	Verze profilu.

BasicDependency

Objekt

Informace o závislostech nasazení

Name	Typ	Description
id	string	ID závislosti.
resourceName	string	Název prostředku závislosti.
resourceType	string	Typ prostředku závislosti.

CloudError

Objekt

Odpověď na chybu žádosti o správu prostředků.

Name	Typ	Description
error	ErrorResponse	Odpověď na chybu Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

DebugSetting

Objekt

Nastavení ladění.

Name	Typ	Description
detailLevel	string	Určuje typ informací, které se mají protokolovat pro ladění. Povolené hodnoty nejsou žádné, requestContent, responseContent nebo requestContent i responseContent oddělené čárkou. Výchozí hodnota není žádná. Při nastavování této hodnoty pečlivě zvažte typ informací, které předáváte během nasazování. Protokolováním informací o požadavku nebo odpovědi můžete potenciálně vystavit citlivá data načtená prostřednictvím operací nasazení.

Dependency

Objekt

Informace o závislostech nasazení

Name	Typ	Description
dependsOn	BasicDependency[]	Seznam závislostí.
id	string	ID závislosti.
resourceName	string	Název prostředku závislosti.
resourceType	string	Typ prostředku závislosti.

DeploymentDiagnosticsDefinition

Objekt

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
level	Level	Označuje dodatečnou úroveň odezvy.
message	string	Chybová zpráva.
target	string	Cíl chyby.

DeploymentExtended

Objekt

Informace o nasazení

Name	Typ	Description
id	string	Identifikátor nasazení.
location	string	umístění nasazení.
name	string	Název nasazení.
properties	DeploymentPropertiesExtended	Vlastnosti nasazení
tags	object	Značky nasazení
type	string	Typ nasazení.

DeploymentExtensionConfigItem

Objekt

Name	Typ	Description
keyVaultReference	KeyVaultParameterReference	Referenční informace k Azure Key Vault, které slouží k načtení hodnoty tajného klíče vlastnosti konfigurace rozšíření.
type	ExtensionConfigPropertyType	Typ hodnoty vlastnosti konfigurace rozšíření.
value		Hodnota vlastnosti extension config.

DeploymentExtensionDefinition

Objekt

Name	Typ	Description
alias	string	Alias rozšíření, jak je definován v šabloně nasazení.
config	<string,  DeploymentExtensionConfigItem>	Konfigurace rozšíření.
configId	string	ID konfigurace rozšíření. Jednoznačně identifikuje řídicí rovinu nasazení v rámci rozšíření.
name	string	Název přípony.
version	string	Verze rozšíření.

DeploymentMode

Výčet

Režim, který se používá k nasazení prostředků. Tato hodnota může být přírůstková nebo úplná. V přírůstkovém režimu se prostředky nasazují bez odstranění existujících prostředků, které nejsou součástí šablony. V režimu Dokončení se prostředky nasadí a existující prostředky ve skupině prostředků, které nejsou součástí šablony, se odstraní. Při použití režimu Dokončení buďte opatrní, protože nechtěně odstraňte prostředky.

Hodnota	Description
Incremental
Complete

DeploymentPropertiesExtended

Objekt

Vlastnosti nasazení s dalšími podrobnostmi

Name	Typ	Description
correlationId	string	ID korelace nasazení.
debugSetting	DebugSetting	Nastavení ladění nasazení.
dependencies	Dependency[]	Seznam závislostí nasazení
diagnostics	DeploymentDiagnosticsDefinition[]	Obsahuje diagnostické informace shromážděné během procesu ověřování.
duration	string	Doba trvání nasazení šablony.
error	ErrorResponse	Odpověď na chybu Chyba nasazení.
extensions	DeploymentExtensionDefinition[]	Rozšíření použitá v tomto nasazení.
mode	DeploymentMode	Režim nasazení. Možné hodnoty jsou přírůstkové a dokončené.
onErrorDeployment	OnErrorDeploymentExtended	Nasazení při chování chyby.
outputResources	ResourceReference[]	Pole zřízených prostředků
outputs	object	Páry klíč/hodnota, které představují výstup nasazení.
parameters	object	Parametry nasazení
parametersLink	ParametersLink	Identifikátor URI odkazující na parametry.
providers	Provider[]	Seznam poskytovatelů prostředků potřebných pro nasazení
provisioningState	ProvisioningState	Označuje stav zřizování.
templateHash	string	Hodnota hash vytvořená pro šablonu.
templateLink	TemplateLink	Identifikátor URI odkazující na šablonu.
timestamp	string (date-time)	Časové razítko nasazení šablony.
validatedResources	ResourceReference[]	Pole ověřených prostředků
validationLevel	ValidationLevel	Úroveň ověření nasazení

ErrorAdditionalInfo

Objekt

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

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

ErrorResponse

Objekt

Odpověď na chybu

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

ExtensionConfigPropertyType

Výčet

Hodnota	Description
String	Typ vlastnosti představující řetězcovou hodnotu.
Int	Typ vlastnosti představující celočíselnou hodnotu.
Bool	Typ vlastnosti představující booleovskou hodnotu.
Array	Typ vlastnosti představující hodnotu pole.
Object	Typ vlastnosti představující hodnotu objektu.
SecureString	Typ vlastnosti představující hodnotu zabezpečeného řetězce.
SecureObject	Typ vlastnosti představující hodnotu zabezpečeného objektu.

KeyVaultParameterReference

Objekt

Referenční informace k parametrům služby Azure Key Vault

Name	Typ	Description
keyVault	KeyVaultReference	Referenční informace ke službě Azure Key Vault
secretName	string	Název tajného kódu služby Azure Key Vault
secretVersion	string	Verze tajného kódu služby Azure Key Vault

KeyVaultReference

Objekt

Referenční informace ke službě Azure Key Vault

Name	Typ	Description
id	string	ID prostředku služby Azure Key Vault

Level

Výčet

Označuje dodatečnou úroveň odezvy.

Hodnota	Description
Warning
Info
Error

OnErrorDeploymentExtended

Objekt

Nasazení při chování chyby s dalšími podrobnostmi

Name	Typ	Description
deploymentName	string	Nasazení, které se má použít v případě chyby.
provisioningState	string	Stav zřizování pro nasazení chyby
type	OnErrorDeploymentType	Nasazení typu chování chyby. Možné hodnoty jsou LastSuccessful a SpecificDeployment.

OnErrorDeploymentType

Výčet

Nasazení typu chování chyby. Možné hodnoty jsou LastSuccessful a SpecificDeployment.

Hodnota	Description
LastSuccessful
SpecificDeployment

ParametersLink

Objekt

Entita představující odkaz na parametry nasazení

Name	Typ	Description
contentVersion	string	V případě zahrnutí se musí shodovat s ContentVersion v šabloně.
uri	string	Identifikátor URI souboru parametrů.

Provider

Objekt

Informace o poskytovateli prostředků

Name	Typ	Description
id	string	ID zprostředkovatele.
namespace	string	Obor názvů poskytovatele prostředků.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	Stav souhlasu s autorizací zprostředkovatele.
registrationPolicy	string	Zásady registrace poskytovatele prostředků.
registrationState	string	Stav registrace poskytovatele prostředků.
resourceTypes	ProviderResourceType[]	Kolekce typů prostředků poskytovatele.

ProviderAuthorizationConsentState

Výčet

Stav souhlasu s autorizací zprostředkovatele.

Hodnota	Description
NotSpecified
Required
NotRequired
Consented

ProviderExtendedLocation

Objekt

Rozšířené umístění poskytovatele.

Name	Typ	Description
extendedLocations	string[]	Rozšířená umístění pro umístění Azure.
location	string	Umístění Azure.
type	string	Typ rozšířeného umístění.

ProviderResourceType

Objekt

Typ prostředku spravovaný poskytovatelem prostředků

Name	Typ	Description
aliases	Alias[]	Aliasy podporované tímto typem prostředku.
apiProfiles	ApiProfile[]	Profily rozhraní API pro poskytovatele prostředků.
apiVersions	string[]	Verze rozhraní API.
capabilities	string	Další možnosti, které tento typ prostředku nabízí.
defaultApiVersion	string	Výchozí verze rozhraní API.
locationMappings	ProviderExtendedLocation[]	Mapování umístění, která jsou podporována tímto typem prostředku.
locations	string[]	Kolekce umístění, kde lze tento typ prostředku vytvořit.
properties	object	Vlastnosti.
resourceType	string	Typ zdroje.
zoneMappings	ZoneMapping[]

ProvisioningState

Výčet

Označuje stav zřizování.

Hodnota	Description
NotSpecified
Accepted
Running
Ready
Creating
Created
Deleting
Deleted
Canceled
Failed
Succeeded
Updating

ResourceReference

Objekt

Model ID prostředku.

Name	Typ	Description
apiVersion	string	Verze rozhraní API, se kterou byl prostředek nasazen.
extension	DeploymentExtensionDefinition	Rozšíření, se kterým byl prostředek nasazen.
id	string	Plně kvalifikované ID prostředku Azure.
identifiers	object	Rozšiřitelné identifikátory prostředků.
resourceType	string	Typ zdroje.

TemplateLink

Objekt

Entita představující odkaz na šablonu.

Name	Typ	Description
contentVersion	string	V případě zahrnutí se musí shodovat s ContentVersion v šabloně.
id	string	ID prostředku specifikace šablony. Použijte buď id, nebo vlastnost URI, ale ne obojí.
queryString	string	Řetězec dotazu (například token SAS), který se má použít s identifikátorem URI templateLink.
relativePath	string	Vlastnost relativePath lze použít k nasazení propojené šablony v umístění vzhledem k nadřazené. Pokud byla nadřazená šablona propojena se šablonou TemplateSpec, bude odkazovat na artefakt v templateSpec. Pokud byl nadřazený objekt propojený s identifikátorem URI, bude podřízené nasazení kombinací nadřazených a relativních identifikátorů URI cesty.
uri	string	Identifikátor URI šablony, který se má nasadit. Použijte vlastnost identifikátoru URI nebo ID, ale ne obě.

ValidationLevel

Výčet

Úroveň ověření provedeného při nasazení.

Hodnota	Description
Template	Provede se statická analýza šablony.
Provider	Provede se statická analýza šablony a deklarace prostředků se odešlou poskytovatelům prostředků k sémantickému ověření. Ověří, zda má volající oprávnění k zápisu RBAC pro každý prostředek.
ProviderNoRbac	Provede se statická analýza šablony a deklarace prostředků se odešlou poskytovatelům prostředků k sémantickému ověření. Přeskočí ověření, zda má volající oprávnění k zápisu RBAC pro každý prostředek.

ZoneMapping

Objekt

Name	Typ	Description
location	string	Umístění mapování zóny.
zones	string[]