Compartilhar via


Galleries - Create Or Update

Criar ou atualizar uma Galeria de Imagens Compartilhadas.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}?api-version=2024-03-03

Parâmetros de URI

Nome Em Obrigatório Tipo Description
galleryName
path True

string

O nome da Galeria de Imagens Compartilhadas. Os caracteres permitidos são alfabetos e números com pontos e períodos permitidos no meio. O comprimento máximo é de 80 caracteres.

resourceGroupName
path True

string

O nome do grupo de recursos.

subscriptionId
path True

string

Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.

api-version
query True

string

Versão da API do cliente.

Corpo da solicitação

Nome Obrigatório Tipo Description
location True

string

Local do recurso

identity

GalleryIdentity

A identidade da galeria, se configurada.

properties.description

string

A descrição deste recurso da Galeria de Imagens Compartilhadas. Essa propriedade é atualizável.

properties.identifier

GalleryIdentifier

Descreve o nome exclusivo da galeria.

properties.sharingProfile

SharingProfile

Perfil para compartilhamento de galeria para assinatura ou locatário

properties.softDeletePolicy

SoftDeletePolicy

Contém informações sobre a política de exclusão reversível da galeria.

tags

object

Marcas de recurso

Respostas

Nome Tipo Description
200 OK

Gallery

OKEY

201 Created

Gallery

Criado

202 Accepted

Gallery

Aceitado

Other Status Codes

CloudError

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

Create a community gallery.
Create or update a simple gallery with sharing profile.
Create or update a simple gallery with soft deletion enabled.
Create or update a simple gallery with system-assigned and user-assigned managed identities.
Create or update a simple gallery.

Create a community gallery.

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName?api-version=2024-03-03

{
  "location": "West US",
  "properties": {
    "description": "This is the gallery description.",
    "sharingProfile": {
      "permissions": "Community",
      "communityGalleryInfo": {
        "publisherUri": "uri",
        "publisherContact": "pir@microsoft.com",
        "eula": "eula",
        "publicNamePrefix": "PirPublic"
      }
    }
  }
}

Resposta de exemplo

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "sharingProfile": {
      "permissions": "Community",
      "communityGalleryInfo": {
        "publisherUri": "uri",
        "publisherContact": "pir@microsoft.com",
        "eula": "eula",
        "publicNamePrefix": "PirPublic"
      }
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Creating",
    "sharingProfile": {
      "permissions": "Community",
      "communityGalleryInfo": {
        "publisherUri": "uri",
        "publisherContact": "pir@microsoft.com",
        "eula": "eula",
        "publicNamePrefix": "PirPublic"
      }
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "sharingProfile": {
      "permissions": "Community",
      "communityGalleryInfo": {
        "publisherUri": "uri",
        "publisherContact": "pir@microsoft.com",
        "eula": "eula",
        "publicNamePrefix": "PirPublic"
      }
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName?api-version=2024-03-03

{
  "location": "West US",
  "properties": {
    "description": "This is the gallery description.",
    "sharingProfile": {
      "permissions": "Groups"
    }
  }
}

Resposta de exemplo

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "sharingProfile": {
      "permissions": "Groups"
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Creating",
    "sharingProfile": {
      "permissions": "Groups"
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "sharingProfile": {
      "permissions": "Groups"
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName?api-version=2024-03-03

{
  "location": "West US",
  "properties": {
    "description": "This is the gallery description.",
    "softDeletePolicy": {
      "isSoftDeleteEnabled": true
    }
  }
}

Resposta de exemplo

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "softDeletePolicy": {
      "isSoftDeleteEnabled": true
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Creating",
    "softDeletePolicy": {
      "isSoftDeleteEnabled": true
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "softDeletePolicy": {
      "isSoftDeleteEnabled": true
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName?api-version=2024-03-03

{
  "location": "West US",
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity": {}
    }
  },
  "properties": {
    "description": "This is the gallery description."
  }
}

Resposta de exemplo

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "userAssignedIdentities": {
      "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity": {}
    }
  },
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating"
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "userAssignedIdentities": {
      "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity": {}
    }
  },
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Creating",
    "softDeletePolicy": {
      "isSoftDeleteEnabled": true
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName",
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "userAssignedIdentities": {
      "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity": {}
    }
  },
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating",
    "softDeletePolicy": {
      "isSoftDeleteEnabled": true
    }
  },
  "location": "West US",
  "name": "myGalleryName"
}

Create or update a simple gallery.

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName?api-version=2024-03-03

{
  "location": "West US",
  "properties": {
    "description": "This is the gallery description."
  }
}

Resposta de exemplo

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating"
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Creating"
  },
  "location": "West US",
  "name": "myGalleryName"
}
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery",
  "properties": {
    "description": "This is the gallery description.",
    "identifier": {
      "uniqueName": "{subscription-id}-MYGALLERYNAME"
    },
    "provisioningState": "Updating"
  },
  "location": "West US",
  "name": "myGalleryName"
}

Definições

Nome Description
ApiError

Erro de API.

ApiErrorBase

Base de erros de API.

CloudError

Uma resposta de erro do serviço de computação.

CommunityGalleryInfo

Informações da galeria da comunidade se a galeria atual for compartilhada com a comunidade

Gallery

Especifica informações sobre a Galeria de Imagens Compartilhadas que você deseja criar ou atualizar.

GalleryIdentifier

Descreve o nome exclusivo da galeria.

GalleryIdentity

Identidade da máquina virtual.

GalleryProvisioningState

O estado atual da galeria ou do artefato da galeria.

GallerySharingPermissionTypes

Essa propriedade permite que você especifique a permissão de compartilhar a galeria. Os valores possíveis são: Grupos privados,Comunidade.

InnerError

Detalhes do erro interno.

RegionalSharingStatus

Status do compartilhamento regional da galeria

ResourceIdentityType

O tipo de identidade usado para a galeria. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá todas as identidades da galeria.

SharingProfile

Perfil para compartilhamento de galeria para assinatura ou locatário

SharingProfileGroup

Grupo do perfil de compartilhamento da galeria

SharingProfileGroupTypes

Essa propriedade permite que você especifique o tipo de grupo de compartilhamento. Os valores possíveis são: Assinaturas ,AADTenants.

SharingState

O estado de compartilhamento da galeria.

SharingStatus

Compartilhamento de status da galeria atual.

SoftDeletePolicy

Contém informações sobre a política de exclusão reversível da galeria.

UserAssignedIdentities

A lista de identidades de usuário associadas à Máquina Virtual. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiError

Erro de API.

Nome Tipo Description
code

string

O código de erro.

details

ApiErrorBase[]

Os detalhes do erro da API

innererror

InnerError

O erro interno da API

message

string

A mensagem de erro.

target

string

O destino do erro específico.

ApiErrorBase

Base de erros de API.

Nome Tipo Description
code

string

O código de erro.

message

string

A mensagem de erro.

target

string

O destino do erro específico.

CloudError

Uma resposta de erro do serviço de computação.

Nome Tipo Description
error

ApiError

Erro de API.

CommunityGalleryInfo

Informações da galeria da comunidade se a galeria atual for compartilhada com a comunidade

Nome Tipo Description
communityGalleryEnabled

boolean

Contém informações sobre se o compartilhamento da galeria da comunidade está habilitado.

eula

string

Contrato de licença do usuário final para a imagem da galeria da comunidade.

publicNamePrefix

string

O prefixo do nome da galeria que será exibido publicamente. Visível para todos os usuários.

publicNames

string[]

Lista de nomes públicos da galeria da comunidade.

publisherContact

string

Email de suporte do editor da galeria da comunidade. O endereço de email do editor. Visível para todos os usuários.

publisherUri

string

O link para o site do editor. Visível para todos os usuários.

Especifica informações sobre a Galeria de Imagens Compartilhadas que você deseja criar ou atualizar.

Nome Tipo Description
id

string

ID do recurso

identity

GalleryIdentity

A identidade da galeria, se configurada.

location

string

Local do recurso

name

string

Nome do recurso

properties.description

string

A descrição deste recurso da Galeria de Imagens Compartilhadas. Essa propriedade é atualizável.

properties.identifier

GalleryIdentifier

Descreve o nome exclusivo da galeria.

properties.provisioningState

GalleryProvisioningState

O estado atual da galeria ou do artefato da galeria.
O estado de provisionamento, que aparece apenas na resposta.

properties.sharingProfile

SharingProfile

Perfil para compartilhamento de galeria para assinatura ou locatário

properties.sharingStatus

SharingStatus

Compartilhamento de status da galeria atual.

properties.softDeletePolicy

SoftDeletePolicy

Contém informações sobre a política de exclusão reversível da galeria.

tags

object

Marcas de recurso

type

string

Tipo de recurso

GalleryIdentifier

Descreve o nome exclusivo da galeria.

Nome Tipo Description
uniqueName

string

O nome exclusivo da Galeria de Imagens Compartilhadas. Esse nome é gerado automaticamente pelo Azure.

GalleryIdentity

Identidade da máquina virtual.

Nome Tipo Description
principalId

string

A ID principal da identidade da galeria. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.

tenantId

string

A ID do locatário do AAD da identidade da galeria. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.

type

ResourceIdentityType

O tipo de identidade usado para a galeria. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá todas as identidades da galeria.

userAssignedIdentities

UserAssignedIdentities

A lista de identidades de usuário associadas à galeria. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

GalleryProvisioningState

O estado atual da galeria ou do artefato da galeria.

Nome Tipo Description
Creating

string

Deleting

string

Failed

string

Migrating

string

Succeeded

string

Updating

string

GallerySharingPermissionTypes

Essa propriedade permite que você especifique a permissão de compartilhar a galeria. Os valores possíveis são: Grupos privados,Comunidade.

Nome Tipo Description
Community

string

Groups

string

Private

string

InnerError

Detalhes do erro interno.

Nome Tipo Description
errordetail

string

A mensagem de erro interna ou o despejo de exceção.

exceptiontype

string

O tipo de exceção.

RegionalSharingStatus

Status do compartilhamento regional da galeria

Nome Tipo Description
details

string

Detalhes da falha de compartilhamento regional da galeria.

region

string

Nome da região

state

SharingState

O estado de compartilhamento da galeria.
Estado de compartilhamento da galeria na região atual

ResourceIdentityType

O tipo de identidade usado para a galeria. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá todas as identidades da galeria.

Nome Tipo Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

SharingProfile

Perfil para compartilhamento de galeria para assinatura ou locatário

Nome Tipo Description
communityGalleryInfo

CommunityGalleryInfo

Informações da galeria da comunidade se a galeria atual for compartilhada com a comunidade.

groups

SharingProfileGroup[]

Uma lista de grupos de perfis de compartilhamento.

permissions

GallerySharingPermissionTypes

Essa propriedade permite que você especifique a permissão de compartilhar a galeria. Os valores possíveis são: Grupos privados,Comunidade.

SharingProfileGroup

Grupo do perfil de compartilhamento da galeria

Nome Tipo Description
ids

string[]

Uma lista de IDs de assinatura/locatário à qual a galeria deve ser compartilhada.

type

SharingProfileGroupTypes

Essa propriedade permite que você especifique o tipo de grupo de compartilhamento. Os valores possíveis são: Assinaturas ,AADTenants.

SharingProfileGroupTypes

Essa propriedade permite que você especifique o tipo de grupo de compartilhamento. Os valores possíveis são: Assinaturas ,AADTenants.

Nome Tipo Description
AADTenants

string

Subscriptions

string

SharingState

O estado de compartilhamento da galeria.

Nome Tipo Description
Failed

string

InProgress

string

Succeeded

string

Unknown

string

SharingStatus

Compartilhamento de status da galeria atual.

Nome Tipo Description
aggregatedState

SharingState

O estado de compartilhamento da galeria.
Estado de compartilhamento agregado da galeria atual.

summary

RegionalSharingStatus[]

Resumo de todo o status de compartilhamento regional.

SoftDeletePolicy

Contém informações sobre a política de exclusão reversível da galeria.

Nome Tipo Description
isSoftDeleteEnabled

boolean

Permite a exclusão temporária de recursos nesta galeria, permitindo que eles sejam recuperados dentro do tempo de retenção.

UserAssignedIdentities

A lista de identidades de usuário associadas à Máquina Virtual. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Nome Tipo Description