swagger: '2.0'
info:
version: 2020-08-01-preview
title: Microsoft Azure AccessControlClient AccessConnector GallerySharingUpdate API
schemes:
- https
tags:
- name: GallerySharingUpdate
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/share
: post:
tags:
- GallerySharingUpdate
operationId: microsoftAzureGallerysharingprofileUpdate
description: Update sharing profile of a gallery.
parameters:
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ResourceGroupNameParameter'
- name: galleryName
in: path
required: true
type: string
description: The name of the Shared Image Gallery.
- $ref: '#/parameters/ApiVersionParameter'
- name: sharingUpdate
in: body
required: true
schema:
$ref: '#/definitions/SharingUpdate'
description: Parameters supplied to the update gallery sharing profile.
responses:
'200':
description: OK
schema:
$ref: '#/definitions/SharingUpdate'
'202':
description: Accepted
schema:
$ref: '#/definitions/SharingUpdate'
default:
description: Error response describing why the operation failed.
schema:
$ref: '#/definitions/CloudError'
x-ms-long-running-operation: true
x-ms-examples:
Add sharing id to the sharing profile of a gallery.:
$ref: ./examples/AddToSharingProfileInAGallery.json
reset sharing profile of a gallery.:
$ref: ./examples/ResetSharingProfileInAGallery.json
summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Galleries Galleryname Share
definitions:
SharingUpdate:
description: Specifies information about the gallery sharing profile update.
properties:
operationType:
type: string
description: 'This property allows you to specify the operation type of gallery sharing update.
Possible values are:
**Add**
**Remove**
**Reset**'
enum:
- Add
- Remove
- Reset
x-ms-enum:
name: SharingUpdateOperationTypes
modelAsString: true
groups:
type: array
items:
$ref: '#/definitions/SharingProfileGroup'
description: A list of sharing profile groups.
required:
- operationType
x-ms-azure-resource: true
CloudError:
x-ms-external: true
properties:
error:
$ref: '#/definitions/ApiError'
description: An error response from the Compute service.
SharingProfileGroup:
description: Group of the gallery sharing profile
properties:
type:
type: string
description: 'This property allows you to specify the type of sharing group.
Possible values are:
**Subscriptions**
**AADTenants**'
enum:
- Subscriptions
- AADTenants
x-ms-enum:
name: SharingProfileGroupTypes
modelAsString: true
ids:
type: array
items:
type: string
description: A list of subscription/tenant ids the gallery is aimed to be shared to.
ApiError:
properties:
details:
type: array
items:
$ref: '#/definitions/ApiErrorBase'
description: The Api error details
innererror:
$ref: '#/definitions/InnerError'
description: The Api inner error
code:
type: string
description: The error code.
target:
type: string
description: The target of the particular error.
message:
type: string
description: The error message.
description: Api error.
ApiErrorBase:
properties:
code:
type: string
description: The error code.
target:
type: string
description: The target of the particular error.
message:
type: string
description: The error message.
description: Api error base.
InnerError:
properties:
exceptiontype:
type: string
description: The exception type.
errordetail:
type: string
description: The internal error message or exception dump.
description: Inner error details.
parameters:
ApiVersionParameter:
name: api-version
in: query
required: true
type: string
description: Client Api Version.
SubscriptionIdParameter:
name: subscriptionId
in: path
required: true
type: string
description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
ResourceGroupNameParameter:
name: resourceGroupName
in: path
required: true
type: string
x-ms-parameter-location: method
description: The name of the resource group.
x-ms-parameterized-host:
hostTemplate: '{endpoint}'
useSchemePrefix: false
parameters:
- $ref: '#/parameters/Endpoint'