Deployments - Get At Management Group Scope

Tjänst:

Resource Management

API-version:

2021-04-01

Hämtar en distribution.

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2021-04-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
deploymentName	path	True	string	Namnet på distributionen. Reguljärt uttrycksmönster: ^[-\w\._\(\)]+$
groupId	path	True	string	Hanteringsgruppens ID.
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 Flow

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	Typ 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	Aliastypen.
ApiProfile
BasicDependency	Information om distributionsberoende.
CloudError	Ett felsvar för en resurshanteringsbegäran.
DebugSetting	Felsökningsinställningen.
Dependency	Information om distributionsberoende.
DeploymentExtended	Distributionsinformation.
DeploymentMode	Det läge 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 fullständigt läge eftersom du oavsiktligt kan ta bort resurser.
DeploymentPropertiesExtended	Distributionsegenskaper med ytterligare information.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorResponse	Felsvar
OnErrorDeploymentExtended	Distribution av felbeteende med ytterligare information.
OnErrorDeploymentType	Distributionen av felbeteendetypen. Möjliga värden är LastSuccessful och SpecificDeployment.
ParametersLink	Entitet som representerar referensen till distributionsparametrarna.
Provider	Information om resursprovidern.
ProviderAuthorizationConsentState	Tillstånd för medgivande för providerauktorisering.
ProviderExtendedLocation	Providerns utökade plats.
ProviderResourceType	Resurstyp som hanteras av resursprovidern.
ProvisioningState	Anger etableringsstatus.
ResourceReference	Resurs-ID-modellen.
TemplateLink	Entitet som representerar referensen till mallen.
ZoneMapping

Alias

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	Aliastypen.

AliasPath

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

Name	Typ	Description
apiVersions	string[]	API-versionerna.
metadata	AliasPathMetadata	Aliassökvägens metadata. Om det saknas återgår du till aliasets standardmetadata.
path	string	Sökvägen till ett alias.
pattern	AliasPattern	Mönstret för en aliassökväg.

AliasPathAttributes

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

Name	Typ	Description
Modifiable	string	Den token som aliassökvägen refererar till kan ändras av principer med effekten "ändra".
None	string	Den token som aliassökvägen refererar till har inga attribut.

AliasPathMetadata

Name	Typ	Description
attributes	AliasPathAttributes	Attributen för token som aliassökvägen refererar till.
type	AliasPathTokenType	Typ av token som aliassökvägen refererar till.

AliasPathTokenType

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

Name	Typ	Description
Any	string	Tokentypen kan vara vad som helst.
Array	string	Tokentypen är matris.
Boolean	string	Tokentypen är boolesk.
Integer	string	Tokentypen är heltal.
NotSpecified	string	Tokentypen har inte angetts.
Number	string	Tokentypen är tal.
Object	string	Tokentypen är objekt.
String	string	Tokentypen är sträng.

AliasPattern

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

Typ av aliasmönster

Name	Typ	Description
Extract	string	Extrahering är det enda tillåtna värdet.
NotSpecified	string	NotSpecified tillåts inte.

AliasType

Aliastypen.

Name	Typ	Description
Mask	string	Aliasvärdet är hemligt.
NotSpecified	string	Aliastypen är okänd (samma som att inte ange aliastyp).
PlainText	string	Aliasvärdet är inte hemligt.

ApiProfile

Name	Typ	Description
apiVersion	string	API-versionen.
profileVersion	string	Profilversionen.

BasicDependency

Information om distributionsberoende.

Name	Typ	Description
id	string	ID för beroendet.
resourceName	string	Namnet på beroenderesursen.
resourceType	string	Beroenderesurstypen.

CloudError

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 OData-felsvarsformatet.)

DebugSetting

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 none, requestContent, responseContent eller både requestContent och responseContent avgränsade med ett kommatecken. Standardvärdet är none. 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

Information om distributionsberoende.

Name	Typ	Description
dependsOn	BasicDependency[]	Listan över beroenden.
id	string	ID för beroendet.
resourceName	string	Namnet på beroenderesursen.
resourceType	string	Beroenderesurstypen.

DeploymentExtended

Distributionsinformation.

Name	Typ	Description
id	string	ID för distributionen.
location	string	platsen för distributionen.
name	string	Namnet på distributionen.
properties	DeploymentPropertiesExtended	Distributionsegenskaper.
tags	object	Distributionstaggar
type	string	Typ av distribution.

DeploymentMode

Det läge 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 fullständigt läge eftersom du oavsiktligt kan ta bort resurser.

Name	Typ	Description
Complete	string
Incremental	string

DeploymentPropertiesExtended

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.
duration	string	Varaktigheten för malldistributionen.
error	ErrorResponse	Felsvar Distributionsfelet.
mode	DeploymentMode	Distributionsläget. Möjliga värden är Inkrementella och Slutför.
onErrorDeployment	OnErrorDeploymentExtended	Distributionen av felbeteende.
outputResources	ResourceReference[]	Matris med etablerade resurser.
outputs	object	Nyckel/värde-par som representerar distributionsutdata.
parameters	object	Distributionsparametrar.
parametersLink	ParametersLink	Den URI som refererar till parametrarna.
providers	Provider[]	Listan över resursproviders som behövs för distributionen.
provisioningState	ProvisioningState	Anger etableringsstatus.
templateHash	string	Den hash som skapas för mallen.
templateLink	TemplateLink	Den URI som refererar till mallen.
timestamp	string	Tidsstämpeln för malldistributionen.
validatedResources	ResourceReference[]	Matris med verifierade resurser.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

ErrorResponse

Felsvar

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorResponse[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

OnErrorDeploymentExtended

Distribution av felbeteende med ytterligare information.

Name	Typ	Description
deploymentName	string	Distributionen som ska användas i ett felfall.
provisioningState	string	Tillståndet för etableringen för vid feldistributionen.
type	OnErrorDeploymentType	Distributionen av felbeteendetypen. Möjliga värden är LastSuccessful och SpecificDeployment.

OnErrorDeploymentType

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

Name	Typ	Description
LastSuccessful	string
SpecificDeployment	string

ParametersLink

Entitet som representerar referensen till distributionsparametrarna.

Name	Typ	Description
contentVersion	string	Om den ingår måste den matcha ContentVersion i mallen.
uri	string	URI för parameterfilen.

Provider

Information om resursprovidern.

Name	Typ	Description
id	string	Provider-ID:t.
namespace	string	Resursproviderns namnområde.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	Tillstånd för medgivande för providerauktorisering.
registrationPolicy	string	Resursproviderns registreringsprincip.
registrationState	string	Resursproviderns registreringstillstånd.
resourceTypes	ProviderResourceType[]	Insamling av providerresurstyper.

ProviderAuthorizationConsentState

Tillstånd för medgivande för providerauktorisering.

Name	Typ	Description
Consented	string
NotRequired	string
NotSpecified	string
Required	string

ProviderExtendedLocation

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

Resurstyp som hanteras av resursprovidern.

Name	Typ	Description
aliases	Alias[]	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

Anger etableringsstatus.

Name	Typ	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

Resurs-ID-modellen.

Name	Typ	Description
id	string	Det fullständigt kvalificerade resurs-ID:t.

TemplateLink

Entitet som representerar referensen till mallen.

Name	Typ	Description
contentVersion	string	Om den ingår måste den 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 detta till en artefakt i TemplateSpec. Om den överordnade var länkad med en URI är den underordnade distributionen en kombination av de överordnade och relativePath-URI:erna
uri	string	URI:n för mallen som ska distribueras. Använd antingen egenskapen URI eller ID, men inte båda.

ZoneMapping

Name	Typ	Description
location	string	Platsen för zonmappningen.
zones	string[]