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.

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 ser usada para esta operação.

Corpo da solicitação

Nome Obrigatório Tipo Description
location True

string

A localização geográfica onde o recurso reside

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

Tags de recursos.

Respostas

Nome Tipo Description
200 OK

Gallery

Operação de atualização do recurso 'Galeria' bem-sucedida

201 Created

Gallery

Operação de criação do recurso 'Galeria' bem-sucedida

Cabeçalhos

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

Gallery

A solicitação foi aceita 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 do 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

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

GalleryProvisioningState

O estado de provisionamento, que aparece apenas na resposta.

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, que só aparece na resposta.

SharingStatus

Compartilhamento de status da galeria atual.

SoftDeletePolicy

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

systemData

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

UserAssignedIdentitiesValue

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.

createdByType

O tipo de identidade que criou o recurso.

Valor Description
Application
Key
ManagedIdentity
User

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

Nome Tipo Description
id

string

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

identity

GalleryIdentity

A identidade da galeria, se configurada.

location

string

A localização geográfica onde o recurso reside

name

string

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

systemData

systemData

Metadados do Azure Resource Manager que contêm 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 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

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

GalleryProvisioningState

O estado de provisionamento, que aparece apenas na resposta.

Valor Description
Creating
Deleting
Failed
Migrating
Succeeded
Updating

GallerySharingPermissionTypes

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

Valor Description
Community
Groups
Private

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

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.

Valor Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

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.

Valor Description
AADTenants
Subscriptions

SharingState

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

Valor Description
Failed
InProgress
Succeeded
Unknown

SharingStatus

Compartilhamento de status da galeria atual.

Nome Tipo Description
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 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.

systemData

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

Nome Tipo Description
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 Description
clientId

string

A ID do cliente da identidade atribuída pelo usuário.

principalId

string

A ID principal da identidade atribuída pelo usuário.