Dsc Configuration - Get

Service:: Automation

Version d'API:: 2024-10-23

Récupérez la configuration identifiée par le nom de la configuration.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}?api-version=2024-10-23

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
automationAccountName	path	True	string	Nom du compte Automation.
configurationName	path	True	string	Nom de la configuration.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	DscConfiguration	Opération Azure terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Get a DSC Configuration

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/configurations/TemplateBasic?api-version=2024-10-23

Exemple de réponse

Code d’état:: 200

{
  "name": "TemplateBasic",
  "type": "Microsoft.Automation/AutomationAccounts/Configurations",
  "etag": "\"636263396635600000\"",
  "id": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/configurations/TemplateBasic",
  "location": "East US 2",
  "properties": {
    "description": "sample configuration",
    "creationTime": "2017-03-28T23:14:23.56+00:00",
    "jobCount": 0,
    "lastModifiedTime": "2017-03-28T23:14:23.56+00:00",
    "logVerbose": false,
    "parameters": {},
    "provisioningState": null,
    "state": "Published"
  },
  "tags": {}
}

Définitions

Nom	Description
ContentHash	Définition du type de propriété runbook.
ContentSource	Définition de la source de contenu.
ContentSourceType	Obtient ou définit le type de source de contenu.
createdByType	Type d’identité qui a créé la ressource.
DscConfiguration	Définition du type de configuration.
DscConfigurationParameter	Définition du type de paramètre de configuration.
DscConfigurationState	Obtient ou définit l’état de la configuration.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

ContentHash

Objet

Définition du type de propriété runbook.

Nom	Type	Description
algorithm	string	Obtient ou définit l’algorithme de hachage de contenu utilisé pour hacher le contenu.
value	string	Obtient ou définit la valeur de hachage attendue du contenu.

ContentSource

Objet

Définition de la source de contenu.

Nom	Type	Description
hash	ContentHash	Obtient ou définit le hachage.
type	ContentSourceType	Obtient ou définit le type de source de contenu.
value	string	Obtient ou définit la valeur du contenu. Cela est basé sur le type de source de contenu.
version	string	Obtient ou définit la version du contenu.

ContentSourceType

Énumération

Obtient ou définit le type de source de contenu.

Valeur	Description
embeddedContent	Contenu intégré
uri	URI

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

DscConfiguration

Objet

Définition du type de configuration.

Nom	Type	Description
etag	string	Obtient ou définit l’etag de la ressource.
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
location	string	Emplacement géographique où réside la ressource
name	string	Nom de la ressource
properties.creationTime	string (date-time)	Obtient ou définit l’heure de création.
properties.description	string	Obtient ou définit la description.
properties.jobCount	integer (int32)	Obtient ou définit le nombre de travaux de la configuration.
properties.lastModifiedTime	string (date-time)	Obtient ou définit l’heure de dernière modification.
properties.logVerbose	boolean	Obtient ou définit l’option de journal détaillé.
properties.nodeConfigurationCount	integer (int32)	Obtient le nombre de configurations de nœud compilées.
properties.parameters	<string, DscConfigurationParameter>	Obtient ou définit les paramètres de configuration.
properties.provisioningState	enum: Succeeded	Obtient ou définit l’état d’approvisionnement de la configuration.
properties.source	ContentSource	Obtient ou définit la source.
properties.state	DscConfigurationState	Obtient ou définit l’état de la configuration.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

DscConfigurationParameter

Objet

Définition du type de paramètre de configuration.

Nom	Type	Description
defaultValue	string	Obtient ou définit la valeur par défaut du paramètre.
isMandatory	boolean	Obtient ou définit une valeur booléenne pour indiquer si le paramètre est obligatoire ou non.
position	integer (int32)	Obtient ou définit la position du paramètre.
type	string	Obtient ou définit le type du paramètre.

DscConfigurationState

Énumération

Obtient ou définit l’état de la configuration.

Valeur	Description
New	Nouveau
Edit	Éditer
Published	Publié

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.