Dela via

Deployments - Get

Tjänst:
Resource Management
API-version:
2025-04-01

Hämtar en distribution.

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

URI-parametrar

Name I Obligatorisk Typ Description
deploymentName
 path True

string

minLength: 1
maxLength: 64
pattern: ^[-\w\._\(\)]+$

Namnet på utplaceringen.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+$

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId
 path True

string

Prenumerations-ID för Microsoft Azure.
api-version
 query True

string

Den API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

DeploymentExtended

OK – Returnerar information om distributionen, inklusive etableringsstatus.
Other Status Codes

CloudError

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Definitioner

Name Description
Alias

Aliastypen.
AliasPath

Typ av sökvägar för alias.
AliasPathAttributes

Attributen för token som aliassökvägen refererar till.
AliasPathMetadata
AliasPathTokenType

Typen av token som aliassökvägen refererar till.
AliasPattern

Typ av mönster för en aliassökväg.
AliasPatternType

Typ av aliasmönster
AliasType

Typ av alias.
ApiProfile
BasicDependency

Information om distributionsberoende.
CloudError

Ett felsvar för en resurshanteringsbegäran.
DebugSetting

Felsökningsinställningen.
Dependency

Information om distributionsberoende.
DeploymentDiagnosticsDefinition
DeploymentExtended

Distributionsinformation.
DeploymentExtensionConfigItem
DeploymentExtensionDefinition
DeploymentMode

Läget som används för att distribuera resurser. Det här värdet kan vara antingen Inkrementellt eller Slutfört. I inkrementellt läge distribueras resurser utan att befintliga resurser som inte ingår i mallen tas bort. I fullständigt läge distribueras resurser och befintliga resurser i resursgruppen som inte ingår i mallen tas bort. Var försiktig när du använder Slutfört läge eftersom du oavsiktligt kan ta bort resurser.
DeploymentPropertiesExtended

Distributionsegenskaper med ytterligare information.
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorResponse

Felsvar
ExtensionConfigPropertyType
KeyVaultParameterReference

Parameterreferens för Azure Key Vault.
KeyVaultReference

Azure Key Vault-referens.
Level

Anger den ytterligare svarsnivån.
OnErrorDeploymentExtended

Distribution av felbeteende med ytterligare information.
OnErrorDeploymentType

Distributionen på felbeteendetypen. Möjliga värden är LastSuccessful och SpecificDeployment.
ParametersLink

Entitet som representerar referensen till distributionsparametrarna.
Provider

Information om resursprovider.
ProviderAuthorizationConsentState

Tillstånd för providerauktoriseringsmedgivande.
ProviderExtendedLocation

Providerns utökade plats.
ProviderResourceType

Resurstyp som hanteras av resursprovidern.
ProvisioningState

Anger etableringstillståndet.
ResourceReference

Resurs-ID-modellen.
TemplateLink

Entitet som representerar referensen till mallen.
ValidationLevel

Valideringsnivån som utförs på distributionen.
ZoneMapping

Alias

Objekt

Aliastypen.

Name Typ Description
defaultMetadata

AliasPathMetadata

Standardmetadata för aliassökväg. Gäller för standardsökvägen och för alla aliassökvägar som inte har metadata
defaultPath

string

Standardsökvägen för ett alias.
defaultPattern

AliasPattern

Standardmönstret för ett alias.
name

string

Aliasnamnet.
paths

AliasPath[]

Sökvägarna för ett alias.
type

AliasType

Typ av alias.

AliasPath

Objekt

Typ av sökvägar för alias.

Name Typ Description
apiVersions

string[]

API-versionerna.
metadata

AliasPathMetadata

Metadata för aliassökvägen. Om det saknas återgår du till standardmetadata för aliaset.
path

string

Sökvägen till ett alias.
pattern

AliasPattern

Mönstret för en aliassökväg.

AliasPathAttributes

Uppräkning

Attributen för token som aliassökvägen refererar till.

Värde Description
None

Den token som aliassökvägen refererar till har inga attribut.
Modifiable

Den token som aliassökvägen refererar till kan ändras av principer med "ändra"-effekt.

AliasPathMetadata

Objekt
Name Typ Description
attributes

AliasPathAttributes

Attributen för token som aliassökvägen refererar till.
type

AliasPathTokenType

Typen av token som aliassökvägen refererar till.

AliasPathTokenType

Uppräkning

Typen av token som aliassökvägen refererar till.

Värde Description
NotSpecified

Tokentypen har inte angetts.
Any

Tokentypen kan vara vad som helst.
String

Tokentypen är sträng.
Object

Tokentypen är objekt.
Array

Tokentypen är matris.
Integer

Tokentypen är heltal.
Number

Tokentypen är tal.
Boolean

Tokentypen är boolesk.

AliasPattern

Objekt

Typ av mönster för en aliassökväg.

Name Typ Description
phrase

string

Frasen aliasmönster.
type

AliasPatternType

Typ av aliasmönster
variable

string

Aliasmönstervariabeln.

AliasPatternType

Uppräkning

Typ av aliasmönster

Värde Description
NotSpecified

NotSpecified tillåts inte.
Extract

Extrahering är det enda tillåtna värdet.

AliasType

Uppräkning

Typ av alias.

Värde Description
NotSpecified

Aliastypen är okänd (samma som att inte ange aliastyp).
PlainText

Aliasvärdet är inte hemligt.
Mask

Aliasvärdet är hemligt.

ApiProfile

Objekt
Name Typ Description
apiVersion

string

API-versionen.
profileVersion

string

Profilversionen.

BasicDependency

Objekt

Information om distributionsberoende.

Name Typ Description
id

string

Beroendets ID.
resourceName

string

Namnet på beroenderesursen.
resourceType

string

Beroenderesurstypen.

CloudError

Objekt

Ett felsvar för en resurshanteringsbegäran.

Name Typ Description
error

ErrorResponse

Felsvar
Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.)

DebugSetting

Objekt

Felsökningsinställningen.

Name Typ Description
detailLevel

string

Anger vilken typ av information som ska loggas för felsökning. De tillåtna värdena är inga, requestContent, responseContent eller både requestContent och responseContent avgränsade med ett kommatecken. Standardvärdet är ingen. När du anger det här värdet bör du noga överväga vilken typ av information du skickar in under distributionen. Genom att logga information om begäran eller svaret kan du potentiellt exponera känsliga data som hämtas via distributionsåtgärderna.

Dependency

Objekt

Information om distributionsberoende.

Name Typ Description
dependsOn

BasicDependency[]

Listan över beroenden.
id

string

Beroendets ID.
resourceName

string

Namnet på beroenderesursen.
resourceType

string

Beroenderesurstypen.

DeploymentDiagnosticsDefinition

Objekt
Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.
code

string

Felkoden.
level

Level

Anger den ytterligare svarsnivån.
message

string

Felmeddelandet.
target

string

Felmålet.

DeploymentExtended

Objekt

Distributionsinformation.

Name Typ Description
id

string

ID:t för distributionen.
location

string

distributionens plats.
name

string

Namnet på utplaceringen.
properties

DeploymentPropertiesExtended

Distributionsegenskaper.
tags

object

Distributionstaggar
type

string

Typ av distribution.

DeploymentExtensionConfigItem

Objekt
Name Typ Description
keyVaultReference

KeyVaultParameterReference

Azure Key Vault-referensen som används för att hämta det hemliga värdet för egenskapen extension config.
type

ExtensionConfigPropertyType

Värdetypen för tilläggskonfigurationsegenskapen.
value

Värdet för egenskapen extension config.

DeploymentExtensionDefinition

Objekt
Name Typ Description
alias

string

Aliaset för tillägget enligt definitionen i distributionsmallen.
config

<string,  DeploymentExtensionConfigItem>

Tilläggskonfigurationen.
configId

string

Konfigurations-ID:t för tillägget. Den identifierar unikt ett distributionskontrollplan i ett tillägg.
name

string

Tilläggsnamnet.
version

string

Tilläggsversionen.

DeploymentMode

Uppräkning

Läget som används för att distribuera resurser. Det här värdet kan vara antingen Inkrementellt eller Slutfört. I inkrementellt läge distribueras resurser utan att befintliga resurser som inte ingår i mallen tas bort. I fullständigt läge distribueras resurser och befintliga resurser i resursgruppen som inte ingår i mallen tas bort. Var försiktig när du använder Slutfört läge eftersom du oavsiktligt kan ta bort resurser.

Värde Description
Incremental
Complete

DeploymentPropertiesExtended

Objekt

Distributionsegenskaper med ytterligare information.

Name Typ Description
correlationId

string

Korrelations-ID för distributionen.
debugSetting

DebugSetting

Felsökningsinställningen för distributionen.
dependencies

Dependency[]

Listan över distributionsberoenden.
diagnostics

DeploymentDiagnosticsDefinition[]

Innehåller diagnostikinformation som samlats in under valideringsprocessen.
duration

string

Varaktigheten för malldistributionen.
error

ErrorResponse

Felsvar
Distributionsfelet.
extensions

DeploymentExtensionDefinition[]

De tillägg som används i den här distributionen.
mode

DeploymentMode

Distributionsläget. Möjliga värden är Inkrementella och Slutför.
onErrorDeployment

OnErrorDeploymentExtended

Distributionen på felbeteende.
outputResources

ResourceReference[]

Matris med etablerade resurser.
outputs

object

Nyckel/värde-par som representerar distributionsutdata.
parameters

object

Distributionsparametrar.
parametersLink

ParametersLink

URI:n som refererar till parametrarna.
providers

Provider[]

Listan över resursprovidrar som behövs för distributionen.
provisioningState

ProvisioningState

Anger etableringstillståndet.
templateHash

string

Den hash som skapats för mallen.
templateLink

TemplateLink

URI:n som refererar till mallen.
timestamp

string (date-time)

Tidsstämpeln för malldistributionen.
validatedResources

ResourceReference[]

Matris med verifierade resurser.
validationLevel

ValidationLevel

Valideringsnivån för distributionen

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.
type

string

Ytterligare informationstyp.

ErrorResponse

Objekt

Felsvar

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.
code

string

Felkoden.
details

ErrorResponse[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

ExtensionConfigPropertyType

Uppräkning
Värde Description
String

Egenskapstyp som representerar ett strängvärde.
Int

Egenskapstyp som representerar ett heltalsvärde.
Bool

Egenskapstyp som representerar ett booleskt värde.
Array

Egenskapstyp som representerar ett matrisvärde.
Object

Egenskapstyp som representerar ett objektvärde.
SecureString

Egenskapstyp som representerar ett säkert strängvärde.
SecureObject

Egenskapstyp som representerar ett säkert objektvärde.

KeyVaultParameterReference

Objekt

Parameterreferens för Azure Key Vault.

Name Typ Description
keyVault

KeyVaultReference

Azure Key Vault-referens.
secretName

string

Hemligt namn på Azure Key Vault.
secretVersion

string

Hemlig version av Azure Key Vault.

KeyVaultReference

Objekt

Azure Key Vault-referens.

Name Typ Description
id

string

Resurs-ID för Azure Key Vault.

Level

Uppräkning

Anger den ytterligare svarsnivån.

Värde Description
Warning
Info
Error

OnErrorDeploymentExtended

Objekt

Distribution av felbeteende med ytterligare information.

Name Typ Description
deploymentName

string

Distributionen som ska användas i felfall.
provisioningState

string

Tillståndet för etableringen för on error-distributionen.
type

OnErrorDeploymentType

Distributionen på felbeteendetypen. Möjliga värden är LastSuccessful och SpecificDeployment.

OnErrorDeploymentType

Uppräkning

Distributionen på felbeteendetypen. Möjliga värden är LastSuccessful och SpecificDeployment.

Värde Description
LastSuccessful
SpecificDeployment
Objekt

Entitet som representerar referensen till distributionsparametrarna.

Name Typ Description
contentVersion

string

Om det ingår måste det matcha ContentVersion i mallen.
uri

string

URI:n för parameterfilen.

Provider

Objekt

Information om resursprovider.

Name Typ Description
id

string

Provider-ID:t.
namespace

string

Resursproviderns namnområde.
providerAuthorizationConsentState

ProviderAuthorizationConsentState

Tillstånd för providerauktoriseringsmedgivande.
registrationPolicy

string

Resursproviderns registreringsprincip.
registrationState

string

Resursproviderns registreringstillstånd.
resourceTypes

ProviderResourceType[]

Samlingen med providerresurstyper.

ProviderAuthorizationConsentState

Uppräkning

Tillstånd för providerauktoriseringsmedgivande.

Värde Description
NotSpecified
Required
NotRequired
Consented

ProviderExtendedLocation

Objekt

Providerns utökade plats.

Name Typ Description
extendedLocations

string[]

De utökade platserna för azure-platsen.
location

string

Azure-platsen.
type

string

Den utökade platstypen.

ProviderResourceType

Objekt

Resurstyp som hanteras av resursprovidern.

Name Typ Description
aliases

Alias[]

De alias som stöds av den här resurstypen.
apiProfiles

ApiProfile[]

API-profilerna för resursprovidern.
apiVersions

string[]

API-versionen.
capabilities

string

De ytterligare funktioner som erbjuds av den här resurstypen.
defaultApiVersion

string

Standard-API-versionen.
locationMappings

ProviderExtendedLocation[]

Platsmappningar som stöds av den här resurstypen.
locations

string[]

Samlingen med platser där den här resurstypen kan skapas.
properties

object

Egenskaperna.
resourceType

string

Resurstypen.
zoneMappings

ZoneMapping[]

ProvisioningState

Uppräkning

Anger etableringstillståndet.

Värde Description
NotSpecified
Accepted
Running
Ready
Creating
Created
Deleting
Deleted
Canceled
Failed
Succeeded
Updating

ResourceReference

Objekt

Resurs-ID-modellen.

Name Typ Description
apiVersion

string

Den API-version som resursen distribuerades med.
extension

DeploymentExtensionDefinition

Tillägget som resursen distribuerades med.
id

string

Det fullständigt kvalificerade Azure-resurs-ID:t.
identifiers

object

De utökningsbara resursidentifierarna.
resourceType

string

Resurstypen.
Objekt

Entitet som representerar referensen till mallen.

Name Typ Description
contentVersion

string

Om det ingår måste det matcha ContentVersion i mallen.
id

string

Resurs-ID:t för en mallspecifikation. Använd antingen id- eller URI-egenskapen, men inte båda.
queryString

string

Frågesträngen (till exempel en SAS-token) som ska användas med templateLink-URI:n.
relativePath

string

Egenskapen relativePath kan användas för att distribuera en länkad mall på en plats i förhållande till den överordnade. Om den överordnade mallen var länkad till en TemplateSpec refererar den till en artefakt i TemplateSpec. Om den överordnade var länkad till en URI är den underordnade distributionen en kombination av överordnade och relativaPath-URI:er
uri

string

URI:n för mallen som ska distribueras. Använd antingen egenskapen URI eller ID, men inte båda.

ValidationLevel

Uppräkning

Valideringsnivån som utförs på distributionen.

Värde Description
Template

Statisk analys av mallen utförs.
Provider

Statisk analys av mallen utförs och resursdeklarationer skickas till resursproviders för semantisk validering. Verifierar att anroparen har RBAC-skrivbehörighet för varje resurs.
ProviderNoRbac

Statisk analys av mallen utförs och resursdeklarationer skickas till resursproviders för semantisk validering. Hoppar över verifieringen av att anroparen har RBAC-skrivbehörighet för varje resurs.

ZoneMapping

Objekt
Name Typ Description
location

string

Platsen för zonmappningen.
zones

string[]