Capacities - Update

Référence

Service:: Power BI Embedded

API Version:: 2021-01-01

Mises à jour l’état actuel de la capacité dédiée spécifiée.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerBIDedicated/capacities/{dedicatedCapacityName}?api-version=2021-01-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
dedicatedCapacityName	path	True	string	Nom de la capacité dédiée. Il doit comporter au moins 3 caractères et pas plus de 63. Regex pattern: `^[a-z][a-z0-9]*$`
resourceGroupName	path	True	string	Nom du groupe de ressources Azure dont fait partie une capacité PowerBIDedicated donnée. Ce nom doit comporter au moins 1 caractère et pas plus de 90. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Identificateur unique d’un abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version de l’API cliente.

Corps de la demande

Nom	Type	Description
properties.administration	DedicatedCapacityAdministrators	Collection d’administrateurs de capacité dédiés
properties.mode	Mode	Spécifie la génération de la capacité Power BI Embedded. Si aucune valeur n’est spécifiée, la valeur par défaut « Gen2 » est utilisée. En savoir plus
sku	CapacitySku	Référence SKU de la ressource capacité dédiée.
tags	object	Paires clé-valeur de propriétés d’approvisionnement supplémentaires.

Réponses

Nom	Type	Description
200 OK	DedicatedCapacity	Ok
202 Accepted	DedicatedCapacity	Accepté
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

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

Exemples

Update capacity parameters

Update capacity to Generation 2

Update capacity parameters

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest?api-version=2021-01-01

{
  "sku": {
    "name": "A1",
    "tier": "PBIE_Azure"
  },
  "tags": {
    "testKey": "testValue"
  },
  "properties": {
    "administration": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    }
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest",
  "location": "West US",
  "name": "azsdktest",
  "properties": {
    "administration": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    },
    "provisioningState": "Provisioning",
    "state": "Provisioning"
  },
  "sku": {
    "name": "A1",
    "tier": "PBIE_Azure"
  },
  "tags": {
    "testKey": "testValue"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-01-01T00:00:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-01T00:00:19.1234567Z"
  }
}

Status code:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/providers/Microsoft.PowerBIDedicated/locations/westus/operationstatuses/7e4f488e-f071-4b1a-ae84-e25682d09e4c?api-version=2021-01-01
Location: https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/providers/Microsoft.PowerBIDedicated/locations/westus/operationresults/7e4f488e-f071-4b1a-ae84-e25682d09e4c?api-version=2021-01-01

Response Body

{
  "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest",
  "location": "West US",
  "name": "azsdktest",
  "properties": {
    "administration": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    },
    "provisioningState": "Provisioning",
    "state": "Provisioning"
  },
  "sku": {
    "name": "A1",
    "tier": "PBIE_Azure"
  },
  "tags": {
    "testKey": "testValue"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-01-01T00:00:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-01T00:00:19.1234567Z"
  }
}

Update capacity to Generation 2

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest?api-version=2021-01-01

{
  "sku": {
    "name": "A1",
    "tier": "PBIE_Azure"
  },
  "tags": {
    "testKey": "testValue"
  },
  "properties": {
    "mode": "Gen2"
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest",
  "location": "West US",
  "name": "azsdktest",
  "properties": {
    "administration": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    },
    "mode": "Gen2",
    "provisioningState": "Provisioning",
    "state": "Provisioning"
  },
  "sku": {
    "name": "A1",
    "tier": "PBIE_Azure"
  },
  "tags": {
    "testKey": "testValue"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-01-01T00:00:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-01T00:00:19.1234567Z"
  }
}

Status code:: 202

Azure-AsyncOperation: https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/providers/Microsoft.PowerBIDedicated/locations/westus/operationstatuses/7e4f488e-f071-4b1a-ae84-e25682d09e4c?api-version=2021-01-01
Location: https://management.azure.com/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/providers/Microsoft.PowerBIDedicated/locations/westus/operationresults/7e4f488e-f071-4b1a-ae84-e25682d09e4c?api-version=2021-01-01

Response Body

{
  "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.PowerBIDedicated/capacities/azsdktest",
  "location": "West US",
  "name": "azsdktest",
  "properties": {
    "administration": {
      "members": [
        "azsdktest@microsoft.com",
        "azsdktest2@microsoft.com"
      ]
    },
    "mode": "Gen2",
    "provisioningState": "Provisioning",
    "state": "Provisioning"
  },
  "sku": {
    "name": "A1",
    "tier": "PBIE_Azure"
  },
  "tags": {
    "testKey": "testValue"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-01-01T00:00:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-01-01T00:00:19.1234567Z"
  }
}

Définitions

Nom	Description
CapacityProvisioningState	État de déploiement actuel de la ressource PowerBI Dedicated. ProvisioningState indique les états pour l’approvisionnement des ressources.
CapacitySku	Représente le nom de la référence SKU et le niveau tarifaire Azure pour la ressource de capacité powerBI dédiée.
CapacitySkuTier	Nom du niveau tarifaire Azure auquel la référence SKU s’applique.
DedicatedCapacity	Représente une instance d’une ressource Capacité dédiée.
DedicatedCapacityAdministrators	Tableau d’identités d’utilisateur administrateur
DedicatedCapacityUpdateParameters	Spécification de la demande d’approvisionnement
Error	Objet error
ErrorResponse	Décrit le format de la réponse d’erreur.
IdentityType	Type d’identité qui a créé/modifié la ressource.
Mode	Spécifie la génération de la capacité Power BI Embedded. Si aucune valeur n’est spécifiée, la valeur par défaut « Gen2 » est utilisée. En savoir plus
State	État actuel de la ressource PowerBI Dedicated. L’état est d’indiquer plus d’états en dehors de l’approvisionnement des ressources.
SystemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

CapacityProvisioningState

État de déploiement actuel de la ressource PowerBI Dedicated. ProvisioningState indique les états pour l’approvisionnement des ressources.

Nom	Type	Description
Deleting	string
Failed	string
Paused	string
Pausing	string
Preparing	string
Provisioning	string
Resuming	string
Scaling	string
Succeeded	string
Suspended	string
Suspending	string
Updating	string

CapacitySku

Représente le nom de la référence SKU et le niveau tarifaire Azure pour la ressource de capacité powerBI dédiée.

Nom	Type	Description
capacity	integer	Capacité de la référence SKU.
name	string	Nom du niveau de référence SKU.
tier	CapacitySkuTier	Nom du niveau tarifaire Azure auquel la référence SKU s’applique.

CapacitySkuTier

Nom du niveau tarifaire Azure auquel la référence SKU s’applique.

Nom	Type	Description
AutoPremiumHost	string
PBIE_Azure	string
Premium	string

DedicatedCapacity

Représente une instance d’une ressource Capacité dédiée.

Nom	Type	Description
id	string	Identificateur qui représente la ressource PowerBI Dedicated.
location	string	Emplacement de la ressource PowerBI Dedicated.
name	string	Nom de la ressource PowerBI Dedicated.
properties.administration	DedicatedCapacityAdministrators	Collection d’administrateurs de capacité dédiés
properties.friendlyName	string	Nom de capacité
properties.mode	Mode	Spécifie la génération de la capacité Power BI Embedded. Si aucune valeur n’est spécifiée, la valeur par défaut « Gen2 » est utilisée. En savoir plus
properties.provisioningState	CapacityProvisioningState	État de déploiement actuel de la ressource PowerBI Dedicated. ProvisioningState indique les états pour l’approvisionnement des ressources.
properties.state	State	État actuel de la ressource PowerBI Dedicated. L’état est d’indiquer plus d’états en dehors de l’approvisionnement des ressources.
properties.tenantId	string	ID de locataire pour la capacité. Utilisé pour créer une capacité Pro Plus.
sku	CapacitySku	Référence SKU de la ressource de capacité PowerBI Dedicated.
systemData	SystemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
tags	object	Paires clé-valeur de propriétés d’approvisionnement de ressources supplémentaires.
type	string	Type de la ressource PowerBI Dedicated.

DedicatedCapacityAdministrators

Tableau d’identités d’utilisateur administrateur

Nom	Type	Description
members	string[]	Tableau d’identités d’utilisateur administrateur.

DedicatedCapacityUpdateParameters

Spécification de la demande d’approvisionnement

Nom	Type	Description
properties.administration	DedicatedCapacityAdministrators	Collection d’administrateurs de capacité dédiés
properties.friendlyName	string	Nom de capacité
properties.mode	Mode	Spécifie la génération de la capacité Power BI Embedded. Si aucune valeur n’est spécifiée, la valeur par défaut « Gen2 » est utilisée. En savoir plus
properties.tenantId	string	ID de locataire pour la capacité. Utilisé pour créer une capacité Pro Plus.
sku	CapacitySku	Référence SKU de la ressource capacité dédiée.
tags	object	Paires clé-valeur de propriétés d’approvisionnement supplémentaires.

Error

Objet error

Nom	Type	Description
code	string	Code d'erreur
message	string	Message d’erreur indiquant la raison de l’échec de l’opération.

ErrorResponse

Décrit le format de la réponse d’erreur.

Nom	Type	Description
error	Error	Objet error

IdentityType

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

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Mode

Spécifie la génération de la capacité Power BI Embedded. Si aucune valeur n’est spécifiée, la valeur par défaut « Gen2 » est utilisée. En savoir plus

Nom	Type	Description
Gen1	string
Gen2	string

State

État actuel de la ressource PowerBI Dedicated. L’état est d’indiquer plus d’états en dehors de l’approvisionnement des ressources.

Nom	Type	Description
Deleting	string
Failed	string
Paused	string
Pausing	string
Preparing	string
Provisioning	string
Resuming	string
Scaling	string
Succeeded	string
Suspended	string
Suspending	string
Updating	string

SystemData

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

Nom	Type	Description
createdAt	string	Horodatage de la création de ressource (UTC)
createdBy	string	Identificateur de l’identité qui a créé la ressource
createdByType	IdentityType	Type d’identité qui a créé la ressource
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identificateur de l’identité qui a modifié la ressource pour la dernière fois
lastModifiedByType	IdentityType	Type d’identité qui a modifié la ressource pour la dernière fois

Capacities - Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Scopes

Exemples

Update capacity parameters

Sample Request

Sample Response

Update capacity to Generation 2

Sample Request

Sample Response

Définitions

CapacityProvisioningState

CapacitySku

CapacitySkuTier

DedicatedCapacity

DedicatedCapacityAdministrators

DedicatedCapacityUpdateParameters

Error

ErrorResponse

IdentityType

Mode

State

SystemData

Ressources supplémentaires