Partilhar via


Galleries - Create Or Update

Crie ou atualize uma Galeria de Imagens Partilhadas.

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

Parâmetros URI

Nome Em Necessário Tipo Descrição
galleryName
path True

string

pattern: ^[^_\W][\w-._]{0,79}(?

O nome da Galeria de Imagens Compartilhadas.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

subscriptionId
path True

string

minLength: 1

A ID da assinatura de destino.

api-version
query True

string

minLength: 1

A versão da API a utilizar para esta operação.

Órgão do Pedido

Nome Necessário Tipo Descrição
location True

string

A geolocalização onde o recurso vive

identity

GalleryIdentity

A identidade da galeria, se configurada.

properties.description

string

A descrição deste recurso da Galeria de Imagens Partilhadas. Esta 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 flexível da galeria.

tags

object

Tags de recursos.

Respostas

Nome Tipo Descrição
200 OK

Gallery

Operação de atualização da 'Galeria' de recursos bem-sucedida

201 Created

Gallery

Operação de criação de 'Galeria' de recursos bem-sucedida

Cabeçalhos

  • Location: string
  • Retry-After: integer
202 Accepted

Gallery

O pedido foi aceite para processamento, mas o processamento ainda não foi concluído.

Cabeçalhos

  • Location: string
  • Retry-After: integer
Other Status Codes

CloudError

Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Alcances

Nome Descrição
user_impersonation personificar a sua conta de utilizador

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.

Pedido 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"
}

Pedido 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"
}

Pedido 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"
}

Pedido 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.

Pedido 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 Descrição
ApiError

Erro de api.

ApiErrorBase

Base de erro da 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

createdByType

O tipo de identidade que criou o recurso.

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 para a máquina virtual.

GalleryProvisioningState

O estado de provisionamento, que só aparece na resposta.

GallerySharingPermissionTypes

Esta propriedade permite que você especifique a permissão de compartilhamento da galeria. Os valores possíveis são: Privado,GruposComunidade.

InnerError

Detalhes do erro interno.

RegionalSharingStatus

Estado de partilha 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 'Nenhum' removerá todas as identidades da galeria.

SharingProfile

Perfil para compartilhamento de galeria para assinatura ou locatário

SharingProfileGroup

Grupo do perfil de partilha da galeria

SharingProfileGroupTypes

Esta propriedade permite especificar o tipo de grupo de compartilhamento. Os valores possíveis são: Assinaturas,AADTenants.

SharingState

O estado de compartilhamento da galeria, que só aparece na resposta.

SharingStatus

Status de compartilhamento da galeria atual.

SoftDeletePolicy

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

systemData

Metadados referentes à criação e última modificação do recurso.

UserAssignedIdentitiesValue

ApiError

Erro de api.

Nome Tipo Descrição
code

string

O código de erro.

details

ApiErrorBase[]

Os detalhes do erro Api

innererror

InnerError

O erro interno da Api

message

string

A mensagem de erro.

target

string

O alvo do erro específico.

ApiErrorBase

Base de erro da api.

Nome Tipo Descrição
code

string

O código de erro.

message

string

A mensagem de erro.

target

string

O alvo do erro específico.

CloudError

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

Nome Tipo Descrição
error

ApiError

Erro de api.

CommunityGalleryInfo

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

Nome Tipo Descrição
communityGalleryEnabled

boolean

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

eula

string

Contrato de licença de utilizador 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

E-mail de suporte do editor da galeria da comunidade. O endereço de e-mail do editor. Visível para todos os usuários.

publisherUri

string

O link para o site da editora. Visível para todos os usuários.

createdByType

O tipo de identidade que criou o recurso.

Valor Descrição
User
Application
ManagedIdentity
Key

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

Nome Tipo Descrição
id

string

ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

GalleryIdentity

A identidade da galeria, se configurada.

location

string

A geolocalização onde o recurso vive

name

string

O nome do recurso

properties.description

string

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

properties.identifier

GalleryIdentifier

Descreve o nome exclusivo da galeria.

properties.provisioningState

GalleryProvisioningState

O estado de provisionamento, que só aparece na resposta.

properties.sharingProfile

SharingProfile

Perfil para compartilhamento de galeria para assinatura ou locatário

properties.sharingStatus

SharingStatus

Status de compartilhamento da galeria atual.

properties.softDeletePolicy

SoftDeletePolicy

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

systemData

systemData

Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.

tags

object

Tags de recursos.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

GalleryIdentifier

Descreve o nome exclusivo da galeria.

Nome Tipo Descrição
uniqueName

string

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

GalleryIdentity

Identidade para a máquina virtual.

Nome Tipo Descrição
principalId

string

O id principal da identidade da galeria. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.

tenantId

string

O ID de locatário do AAD da identidade da galeria. Esta propriedade só será fornecida para uma identidade atribuída ao 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 'Nenhum' removerá todas as identidades da galeria.

userAssignedIdentities

<string,  UserAssignedIdentitiesValue>

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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

GalleryProvisioningState

O estado de provisionamento, que só aparece na resposta.

Valor Descrição
Creating
Updating
Failed
Succeeded
Deleting
Migrating

GallerySharingPermissionTypes

Esta propriedade permite que você especifique a permissão de compartilhamento da galeria. Os valores possíveis são: Privado,GruposComunidade.

Valor Descrição
Private
Groups
Community

InnerError

Detalhes do erro interno.

Nome Tipo Descrição
errordetail

string

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

exceptiontype

string

O tipo de exceção.

RegionalSharingStatus

Estado de partilha regional da galeria

Nome Tipo Descrição
details

string

Detalhes da falha de compartilhamento regional da galeria.

region

string

Nome da região

state

SharingState

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 'Nenhum' removerá todas as identidades da galeria.

Valor Descrição
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

SharingProfile

Perfil para compartilhamento de galeria para assinatura ou locatário

Nome Tipo Descrição
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

Esta propriedade permite que você especifique a permissão de compartilhamento da galeria. Os valores possíveis são: Privado,GruposComunidade.

SharingProfileGroup

Grupo do perfil de partilha da galeria

Nome Tipo Descrição
ids

string[]

Uma lista de IDs de assinatura/locatário com os quais a galeria deve ser compartilhada.

type

SharingProfileGroupTypes

Esta propriedade permite especificar o tipo de grupo de compartilhamento. Os valores possíveis são: Assinaturas,AADTenants.

SharingProfileGroupTypes

Esta propriedade permite especificar o tipo de grupo de compartilhamento. Os valores possíveis são: Assinaturas,AADTenants.

Valor Descrição
Subscriptions
AADTenants

SharingState

O estado de compartilhamento da galeria, que só aparece na resposta.

Valor Descrição
Succeeded
InProgress
Failed
Unknown

SharingStatus

Status de compartilhamento da galeria atual.

Nome Tipo Descrição
aggregatedState

SharingState

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 flexível da galeria.

Nome Tipo Descrição
isSoftDeleteEnabled

boolean

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

systemData

Metadados referentes à criação e última modificação do recurso.

Nome Tipo Descrição
createdAt

string (date-time)

O carimbo de data/hora da criação de recursos (UTC).

createdBy

string

A identidade que criou o recurso.

createdByType

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt

string (date-time)

O carimbo de data/hora da última modificação do recurso (UTC)

lastModifiedBy

string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentitiesValue

Nome Tipo Descrição
clientId

string

O ID do cliente da identidade atribuída ao usuário.

principalId

string

O id principal da identidade atribuída ao usuário.