Configuration Assignments - Create Or Update

Service:

Maintenance

API Version:

2023-09-01-preview

Creación de una asignación de configuración
Registre la configuración del recurso.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}?api-version=2023-09-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
configurationAssignmentName	path	True	string	Nombre de asignación de configuración
providerName	path	True	string	Nombre del proveedor de recursos
resourceGroupName	path	True	string	Definición de un nombre de grupo de recursos
resourceName	path	True	string	Identificador de recursos
resourceType	path	True	string	Tipo de recurso
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única una suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
location	string	Ubicación del recurso
properties.filter	ConfigurationAssignmentFilterProperties	Propiedades de la asignación de configuración
properties.maintenanceConfigurationId	string	Identificador de configuración de mantenimiento
properties.resourceId	string	El valor de resourceId único

Respuestas

Nombre	Tipo	Description
200 OK	ConfigurationAssignment	Solicitud de actualización de asignación de configuración aceptada
201 Created	ConfigurationAssignment	Solicitud de creación de asignación de configuración aceptada
Other Status Codes	MaintenanceError	BadRequest

Ejemplos

ConfigurationAssignments_CreateOrUpdate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration?api-version=2023-09-01-preview

{
  "properties": {
    "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1"
  }
}

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.maintenance import MaintenanceManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-maintenance
# USAGE
    python configuration_assignments_create_or_update.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 = MaintenanceManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
    )

    response = client.configuration_assignments.create_or_update(
        resource_group_name="examplerg",
        provider_name="Microsoft.Compute",
        resource_type="virtualMachineScaleSets",
        resource_name="smdtest1",
        configuration_assignment_name="workervmConfiguration",
        configuration_assignment={
            "properties": {
                "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1"
            }
        },
    )
    print(response)


# x-ms-original-file: specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-09-01-preview/examples/ConfigurationAssignments_CreateOrUpdate.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

dotnet

using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Maintenance;
using Azure.ResourceManager.Maintenance.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2023-09-01-preview/examples/ConfigurationAssignments_CreateOrUpdate.json
// this example is just showing the usage of "ConfigurationAssignments_CreateOrUpdate" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
string resourceGroupName = "examplerg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// invoke the operation
string providerName = "Microsoft.Compute";
string resourceType = "virtualMachineScaleSets";
string resourceName = "smdtest1";
string configurationAssignmentName = "workervmConfiguration";
MaintenanceConfigurationAssignmentData data = new MaintenanceConfigurationAssignmentData()
{
    MaintenanceConfigurationId = new ResourceIdentifier("/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1"),
};
MaintenanceConfigurationAssignmentData result = await resourceGroupResource.CreateOrUpdateConfigurationAssignmentAsync(providerName, resourceType, resourceName, configurationAssignmentName, data);

Console.WriteLine($"Succeeded: {result}");

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

{
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration",
  "name": "workervmConfiguration",
  "type": "Microsoft.Maintenance/configurationAssignments",
  "properties": {
    "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1",
    "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1"
  }
}

Status code:

201

{
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration",
  "name": "workervmConfiguration",
  "type": "Microsoft.Maintenance/configurationAssignments",
  "properties": {
    "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1",
    "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1"
  }
}

Definiciones

Nombre	Description
ConfigurationAssignment	Asignación de configuración
ConfigurationAssignmentFilterProperties	Consulta de Azure para la configuración de actualización.
createdByType	Tipo de identidad que creó el recurso.
ErrorDetails	Detalles de respuesta de error recibidos del servicio de mantenimiento de Azure.
MaintenanceError	Respuesta de error recibida del servicio de mantenimiento de Azure.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
TagOperators	Filtre las máquinas virtuales por cualquiera o todas las etiquetas especificadas.
TagSettingsProperties	Etiquetar información de filtro para la máquina virtual.

ConfigurationAssignment

Asignación de configuración

Nombre	Tipo	Description
id	string	Identificador completamente calificado del recurso
location	string	Ubicación del recurso
name	string	Nombre del recurso
properties.filter	ConfigurationAssignmentFilterProperties	Propiedades de la asignación de configuración
properties.maintenanceConfigurationId	string	Identificador de configuración de mantenimiento
properties.resourceId	string	El valor de resourceId único
systemData	systemData	Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.
type	string	Tipo de recurso

ConfigurationAssignmentFilterProperties

Consulta de Azure para la configuración de actualización.

Nombre	Tipo	Description
locations	string[]	Lista de ubicaciones a las que se va a definir el ámbito de la consulta.
osTypes	string[]	Lista de sistemas operativos permitidos.
resourceGroups	string[]	Lista de grupos de recursos permitidos.
resourceTypes	string[]	Lista de recursos permitidos.
tagSettings	TagSettingsProperties	Configuración de etiquetas para la máquina virtual.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDetails

Detalles de respuesta de error recibidos del servicio de mantenimiento de Azure.

Nombre	Tipo	Description
code	string	Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta.
message	string	Representación legible del error.

MaintenanceError

Respuesta de error recibida del servicio de mantenimiento de Azure.

Nombre	Tipo	Description
error	ErrorDetails	Detalles del error

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

TagOperators

Filtre las máquinas virtuales por cualquiera o todas las etiquetas especificadas.

Nombre	Tipo	Description
All	string
Any	string

TagSettingsProperties

Etiquetar información de filtro para la máquina virtual.

Nombre	Tipo	Description
filterOperator	TagOperators	Filtre las máquinas virtuales por cualquiera o todas las etiquetas especificadas.
tags	object	Diccionario de etiquetas con su lista de valores.