Guest Configuration Assignments - Get

Referência

Service:: Guest Configuration

API Version:: 2022-01-25

Obter informações sobre uma atribuição de configuração de convidado

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}?api-version=2022-01-25

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
guestConfigurationAssignmentName	path	True	string	O nome da atribuição de configuração de convidado.
resourceGroupName	path	True	string	O nome do grupo de recursos. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	ID da assinatura que identifica exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
vmName	path	True	string	O nome da máquina virtual. Regex pattern: `^[a-zA-Z0-9][-a-zA-Z0-9_.]*[a-zA-Z0-9]$`
api-version	query	True	string	Versão da API do cliente.

Respostas

Nome	Tipo	Description
200 OK	GuestConfigurationAssignment	OK. A atribuição de configuração de convidado foi retornada com êxito.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get a guest configuration assignment

Sample Request

GET https://management.azure.com/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/SecureProtocol?api-version=2022-01-25

from azure.identity import DefaultAzureCredential
from azure.mgmt.guestconfig import GuestConfigurationClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-guestconfig
# USAGE
    python get_a_guest_configuration_assignment.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = GuestConfigurationClient(
        credential=DefaultAzureCredential(),
        subscription_id="mySubscriptionId",
    )

    response = client.guest_configuration_assignments.get(
        resource_group_name="myResourceGroupName",
        guest_configuration_assignment_name="SecureProtocol",
        vm_name="myVMName",
    )
    print(response)


# x-ms-original-file: specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2022-01-25/examples/getGuestConfigurationAssignment.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armguestconfiguration_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/guestconfiguration/armguestconfiguration"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2022-01-25/examples/getGuestConfigurationAssignment.json
func ExampleAssignmentsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armguestconfiguration.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAssignmentsClient().Get(ctx, "myResourceGroupName", "SecureProtocol", "myVMName", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Assignment = armguestconfiguration.Assignment{
	// 	Name: to.Ptr("AuditSecureProtocol"),
	// 	ID: to.Ptr("/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol"),
	// 	Location: to.Ptr("centraluseuap"),
	// 	Properties: &armguestconfiguration.AssignmentProperties{
	// 		AssignmentHash: to.Ptr("E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855"),
	// 		ComplianceStatus: to.Ptr(armguestconfiguration.ComplianceStatusCompliant),
	// 		GuestConfiguration: &armguestconfiguration.Navigation{
	// 			Name: to.Ptr("AuditSecureProtocol"),
	// 			ConfigurationParameter: []*armguestconfiguration.ConfigurationParameter{
	// 			},
	// 			ContentHash: to.Ptr("content hash"),
	// 			ContentURI: to.Ptr("https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip"),
	// 			Version: to.Ptr("1.0.0.3"),
	// 		},
	// 		LastComplianceStatusChecked: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-29T22:14:13.000Z"); return t}()),
	// 		LatestReportID: to.Ptr("/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1"),
	// 		ProvisioningState: to.Ptr(armguestconfiguration.ProvisioningStateSucceeded),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { GuestConfigurationClient } = require("@azure/arm-guestconfiguration");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get information about a guest configuration assignment
 *
 * @summary Get information about a guest configuration assignment
 * x-ms-original-file: specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2022-01-25/examples/getGuestConfigurationAssignment.json
 */
async function getAGuestConfigurationAssignment() {
  const subscriptionId = process.env["GUESTCONFIGURATION_SUBSCRIPTION_ID"] || "mySubscriptionId";
  const resourceGroupName =
    process.env["GUESTCONFIGURATION_RESOURCE_GROUP"] || "myResourceGroupName";
  const guestConfigurationAssignmentName = "SecureProtocol";
  const vmName = "myVMName";
  const credential = new DefaultAzureCredential();
  const client = new GuestConfigurationClient(credential, subscriptionId);
  const result = await client.guestConfigurationAssignments.get(
    resourceGroupName,
    guestConfigurationAssignmentName,
    vmName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.GuestConfiguration;
using Azure.ResourceManager.GuestConfiguration.Models;

// Generated from example definition: specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2022-01-25/examples/getGuestConfigurationAssignment.json
// this example is just showing the usage of "GuestConfigurationAssignments_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this GuestConfigurationVmAssignmentResource created on azure
// for more information of creating GuestConfigurationVmAssignmentResource, please refer to the document of GuestConfigurationVmAssignmentResource
string subscriptionId = "mySubscriptionId";
string resourceGroupName = "myResourceGroupName";
string vmName = "myVMName";
string guestConfigurationAssignmentName = "SecureProtocol";
ResourceIdentifier guestConfigurationVmAssignmentResourceId = GuestConfigurationVmAssignmentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, vmName, guestConfigurationAssignmentName);
GuestConfigurationVmAssignmentResource guestConfigurationVmAssignment = client.GetGuestConfigurationVmAssignmentResource(guestConfigurationVmAssignmentResourceId);

// invoke the operation
GuestConfigurationVmAssignmentResource result = await guestConfigurationVmAssignment.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
GuestConfigurationAssignmentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "location": "centraluseuap",
  "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol",
  "name": "AuditSecureProtocol",
  "properties": {
    "complianceStatus": "Compliant",
    "assignmentHash": "E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855",
    "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1",
    "lastComplianceStatusChecked": "2018-08-29T22:14:13Z",
    "context": null,
    "guestConfiguration": {
      "kind": null,
      "name": "AuditSecureProtocol",
      "version": "1.0.0.3",
      "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip",
      "contentHash": "content hash",
      "configurationParameter": [],
      "configurationSetting": null
    },
    "provisioningState": "Succeeded"
  }
}

Definições

Nome	Description
actionAfterReboot	Especifica o que acontece após uma reinicialização durante a aplicação de uma configuração. Os valores possíveis são ContinueConfiguration e StopConfiguration
AssignmentInfo	Informações sobre a atribuição de configuração de convidado.
AssignmentReport
AssignmentReportResource	O recurso de atribuição de configuração de convidado.
AssignmentReportResourceComplianceReason	Motivo e código para a conformidade do recurso de atribuição de configuração de convidado.
assignmentType	Especifica o tipo de atribuição e a execução da configuração. Os valores possíveis são Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect e ApplyAndMonitor.
complianceStatus	Um valor que indica a conformidade status do computador para a configuração de convidado atribuída.
ConfigurationInfo	Informações sobre a configuração.
configurationMode	Especifica como o LCM(Local Configuration Manager) realmente aplica a configuração aos nós de destino. Os valores possíveis são ApplyOnly, ApplyAndMonitore ApplyAndAutoCorrect.
ConfigurationParameter	Representa um parâmetro de configuração.
ConfigurationSetting	Configuração do LCM (Configuration Manager local).
createdByType	O tipo de identidade que criou o recurso.
Error
ErrorResponse	Resposta de erro de uma falha de operação
GuestConfigurationAssignment	A atribuição de configuração de convidado é uma associação entre uma configuração de computador e convidado.
GuestConfigurationAssignmentProperties	Propriedades de atribuição de configuração de convidado.
GuestConfigurationNavigation	A configuração de convidado é um artefato que encapsula a configuração de DSC e suas dependências. O artefato é um arquivo zip que contém a configuração de DSC (como MOF) e recursos dependentes e outras dependências, como módulos.
kind	Tipo de configuração de convidado. Por exemplo:DSC
provisioningState	O estado de provisionamento, que aparece apenas na resposta.
systemData	Metadados relativos à criação e à última modificação do recurso.
type	Tipo de relatório, consistência ou inicial
VMInfo	Informações sobre a VM.
VMSSVMInfo	Informações sobre a VM VM do VMSS

actionAfterReboot

Especifica o que acontece após uma reinicialização durante a aplicação de uma configuração. Os valores possíveis são ContinueConfiguration e StopConfiguration

Nome	Tipo	Description
ContinueConfiguration	string
StopConfiguration	string

AssignmentInfo

Informações sobre a atribuição de configuração de convidado.

Nome	Tipo	Description
configuration	ConfigurationInfo	Informações sobre a configuração.
name	string	Nome da atribuição de configuração de convidado.

AssignmentReport

Nome	Tipo	Description
assignment	AssignmentInfo	Detalhes de configuração da atribuição de configuração de convidado.
complianceStatus	complianceStatus	Um valor que indica a conformidade status do computador para a configuração de convidado atribuída.
endTime	string	Data e hora de término do status marcar de conformidade da atribuição de configuração de convidado.
id	string	ID de recurso do ARM do relatório para a atribuição de configuração de convidado.
operationType	type	Tipo de relatório, consistência ou inicial
reportId	string	GUID que identifica o relatório de atribuição de configuração de convidado em uma assinatura, grupo de recursos.
resources	AssignmentReportResource[]	A lista de recursos para os quais a conformidade da atribuição de configuração de convidado é verificada.
startTime	string	Data e hora de início do status marcar de conformidade da atribuição de configuração de convidado.
vm	VMInfo	Informações sobre a VM.

AssignmentReportResource

O recurso de atribuição de configuração de convidado.

Nome	Tipo	Description
complianceStatus	complianceStatus	Um valor que indica a conformidade status do computador para a configuração de convidado atribuída.
properties	object	Propriedades de um recurso de atribuição de configuração de convidado.
reasons	AssignmentReportResourceComplianceReason[]	Motivo de conformidade e código de motivo para um recurso.
resourceId	string	Nome da configuração do recurso de atribuição de configuração de convidado.

AssignmentReportResourceComplianceReason

Motivo e código para a conformidade do recurso de atribuição de configuração de convidado.

Nome	Tipo	Description
code	string	Código para a conformidade do recurso de atribuição de configuração de convidado.
phrase	string	Motivo para a conformidade do recurso de atribuição de configuração de convidado.

assignmentType

Especifica o tipo de atribuição e a execução da configuração. Os valores possíveis são Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect e ApplyAndMonitor.

Nome	Tipo	Description
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
Audit	string
DeployAndAutoCorrect	string

complianceStatus

Um valor que indica a conformidade status do computador para a configuração de convidado atribuída.

Nome	Tipo	Description
Compliant	string
NonCompliant	string
Pending	string

ConfigurationInfo

Informações sobre a configuração.

Nome	Tipo	Description
name	string	Nome da configuração.
version	string	Versão da configuração.

configurationMode

Especifica como o LCM(Local Configuration Manager) realmente aplica a configuração aos nós de destino. Os valores possíveis são ApplyOnly, ApplyAndMonitore ApplyAndAutoCorrect.

Nome	Tipo	Description
ApplyAndAutoCorrect	string
ApplyAndMonitor	string
ApplyOnly	string

ConfigurationParameter

Representa um parâmetro de configuração.

Nome	Tipo	Description
name	string	Nome do parâmetro de configuração.
value	string	Valor do parâmetro de configuração.

ConfigurationSetting

Configuração do LCM (Configuration Manager local).

Nome	Tipo	Valor padrão	Description
actionAfterReboot	actionAfterReboot		Especifica o que acontece após uma reinicialização durante a aplicação de uma configuração. Os valores possíveis são ContinueConfiguration e StopConfiguration
allowModuleOverwrite	boolean		Se true – novas configurações baixadas do serviço de pull têm permissão para substituir as antigas no nó de destino. Caso contrário, false
configurationMode	configurationMode		Especifica como o LCM(Local Configuration Manager) realmente aplica a configuração aos nós de destino. Os valores possíveis são ApplyOnly, ApplyAndMonitore ApplyAndAutoCorrect.
configurationModeFrequencyMins	number	15	A frequência, em minutos, em que a configuração atual é verificada e aplicada. Essa propriedade será ignorada se a propriedade ConfigurationMode estiver definida como ApplyOnly. O valor padrão é 15.
rebootIfNeeded	boolean		Defina isso como true para reinicializar automaticamente o nó depois que uma configuração que requer reinicialização for aplicada. Caso contrário, você precisará reinicializar manualmente o nó para qualquer configuração que exigir. O valor padrão é false. Para usar essa configuração quando uma condição de reinicialização for representada por algo diferente do DSC (como o Windows Installer), combine essa configuração com o módulo xPendingReboot.
refreshFrequencyMins	number	30	O intervalo de tempo, em minutos, em que o LCM verifica um serviço de pull para obter configurações atualizadas. Esse valor será ignorado se o LCM não estiver configurado no modo de pull. O valor padrão é 30.

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Error

Nome	Tipo	Description
code	string	Código do erro.
message	string	Mensagem de erro de detalhe indicando por que a operação falhou.

ErrorResponse

Resposta de erro de uma falha de operação

Nome	Tipo	Description
error	Error