Share via

Get Metadata Document

  • Article

 

The Get Metadata Document operation retrieves the service metadata document, which describes the complete data model for the resources exposed by the Windows Azure Import/Export service. The service metadata document is defined by the OData Protocol.

The service metadata document provides the entity data type information that is needed when constructing certain requests against the Import/Export service. It is also needed to correctly parse responses from the Import/Export service.

Request

The Get Metadata Document request may be constructed as follows. HTTPS is required. Replace <subscription-id> with your subscription ID:

Method

Request URI

GET

https://management.core.windows.net/<subscription-id>/services/importexport/$metadata

URI Parameters

None.

Request Headers

The following table describes required and optional request headers.

Request Header

Description

Accept

Optional. If this header is specified, the value must be set to application/xml. Other values will result in response code 406 (Not Acceptable).

Accept-Language

Optional. Currently only the values en and en-us are supported.

Content-Encoding

Optional. If this header is specified, the value must be set to identity.

Content-Length

Optional. If this header is specified, the value must be set to 0.

Content-Type

Optional. If this header is specified, the value must be set to application/xml.

x-ms-date

Optional. If specified, the value should specify the date and time when the request is sent, in RFC 1123 format.

x-ms-version

Required. Specifies the service management version to use for this request. The value of this header must be set to 2014-05-01, or 2014-11-01.

Request Body

None.

Response

The response includes an HTTP status code, a set of response headers, and a response body for successful requests.

Status Code

A successful operation returns status code 200 (OK).

Response Headers

The response for this operation includes the following headers.

Response Header

Description

Content-Encoding

The value of this header will always be identity.

Content-Length

The length of the content returned in the response.

Content-Type

Specifies the format in which the results are returned. The value of this header will always be application/json.

Date

The UTC date and time generated by the service that indicates the time at which the response was initiated, in RFC 1123 formet.

x-ms-request-id

A value that uniquely identifies a request made against the Import/Export service.

x-ms-version

Indicates the version of the Import/Export service used to execute the request.

Sample Request and Response

The following shows a sample request and response for the Get Metadata Document operation.

Request

GET https://management.core.windows.net/afb1a4eb-bc88-4ce1-b1af-dfec80067464/services/importexport/$metadata HTTP/1.1
x-ms-version: 2014-05-01
Content-Type: application/json
Accept: application/xml
Host: management.core.windows.net
Expect: 100-continue
Connection: Keep-Alive

Response

HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 7461
Content-Type: application/xml
Content-Encoding: identity
Content-Language: en-us
Server: 1.0.6198.70 (rd_rdfe_stable.140426-2318) Microsoft-HTTPAPI/2.0
x-ms-servedbyregion: ussouth2
x-ms-version: 2014-05-01
x-ms-request-id: 0907059b58e990f5ac3f3aca0f2ff8ca
Date: Tue, 29 Apr 2014 23:53:14 GMT

<?xml version="1.0" encoding="utf-8"?>
<edmx:Edmx Version="1.0" xmlns:edmx="https://schemas.microsoft.com/ado/2007/06/edmx">
  <edmx:DataServices m:DataServiceVersion="3.0" m:MaxDataServiceVersion="3.0" xmlns:m="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
    <Schema Namespace="Microsoft.Cis.Services.ImportExport.Public" xmlns="https://schemas.microsoft.com/ado/2009/11/edm">
      <EntityContainer Name="ImportExportData" m:IsDefaultEntityContainer="true">
        <EntitySet Name="StorageAccounts" EntityType="Microsoft.Cis.Services.ImportExport.Public.StorageAccount"/>
        <EntitySet Name="Jobs" EntityType="Microsoft.Cis.Services.ImportExport.Public.Job"/>
        <EntitySet Name="Locations" EntityType="Microsoft.Cis.Services.ImportExport.Public.Location"/>
      </EntityContainer>
      <EntityType Name="StorageAccount">
        <Key>
        <PropertyRef Name="Name"/>
        </Key>
        <Property Name="Name" Type="Edm.String" Nullable="false"/>
      </EntityType>
      <EntityType Name="Job">
        <Key>
          <PropertyRef Name="Name"/>
        </Key>
        <Property Name="Name" Type="Edm.String" Nullable="false"/>
        <Property Name="Properties" Type="Microsoft.Cis.Services.ImportExport.Public.Properties" Nullable="false"/>
        <Property Name="DriveList" Type="Collection(Microsoft.Cis.Services.ImportExport.Public.Drive)" Nullable="true"/>
        <Property Name="Export" Type="Microsoft.Cis.Services.ImportExport.Public.ExportFragment" Nullable="true"/>
      </EntityType>
      <EntityType Name="Location">
        <Key>
          <PropertyRef Name="Name"/>
        </Key>
        <Property Name="Name" Type="Edm.String" Nullable="false"/>
        <Property Name="RecipientName" Type="Edm.String" Nullable="false"/>
        <Property Name="StreetAddress1" Type="Edm.String" Nullable="false"/>
        <Property Name="StreetAddress2" Type="Edm.String" Nullable="false"/>
        <Property Name="City" Type="Edm.String" Nullable="false"/>
        <Property Name="StateOrProvince" Type="Edm.String" Nullable="false"/>
        <Property Name="PostalCode" Type="Edm.String" Nullable="false"/>
        <Property Name="CountryOrRegion" Type="Edm.String" Nullable="false"/>
        <Property Name="SupportedCarriers" Type="Collection(Edm.String)" Nullable="true"/>
      </EntityType>
      <ComplexType Name="Properties">
        <Property Name="StorageAccountName" Type="Edm.String" Nullable="true"/>
        <Property Name="StorageAccountKey" Type="Edm.String" Nullable="true"/>
        <Property Name="Location" Type="Edm.String" Nullable="true"/>
        <Property Name="Type" Type="Edm.String" Nullable="true"/>
        <Property Name="FriendlyName" Type="Edm.String" Nullable="true"/>
        <Property Name="Description" Type="Edm.String" Nullable="true"/>
        <Property Name="Metadata" Type="Edm.String" Nullable="true"/>
        <Property Name="State" Type="Edm.String" Nullable="true"/>
        <Property Name="CancelRequested" Type="Edm.Boolean" Nullable="true"/>
        <Property Name="PercentComplete" Type="Edm.Int32" Nullable="true"/>
        <Property Name="ReturnAddress" Type="Microsoft.Cis.Services.ImportExport.Public.ReturnAddress" Nullable="true"/>
        <Property Name="ReturnShipping" Type="Microsoft.Cis.Services.ImportExport.Public.ReturnShipping" Nullable="true"/>
        <Property Name="ShippingInformation" Type="Microsoft.Cis.Services.ImportExport.Public.ShippingInformation" Nullable="true"/>
        <Property Name="DeliveryPackage" Type="Microsoft.Cis.Services.ImportExport.Public.Package" Nullable="true"/>
        <Property Name="ReturnPackage" Type="Microsoft.Cis.Services.ImportExport.Public.Package" Nullable="true"/>
        <Property Name="ImportExportStatesContainer" Type="Edm.String" Nullable="true"/>
        <Property Name="ImportExportStatesPath" Type="Edm.String" Nullable="true"/>
        <Property Name="EnableVerboseLog" Type="Edm.Boolean" Nullable="true"/>
        <Property Name="BackupDriveManifest" Type="Edm.Boolean" Nullable="true"/>
        <Property Name="IncompleteBlobListUri" Type="Edm.String" Nullable="true"/>
      </ComplexType>
      <ComplexType Name="ReturnAddress">
        <Property Name="Name" Type="Edm.String" Nullable="false"/>
        <Property Name="Address" Type="Edm.String" Nullable="false"/>
        <Property Name="Phone" Type="Edm.String" Nullable="true"/>
        <Property Name="Email" Type="Edm.String" Nullable="true"/>
      </ComplexType>
      <ComplexType Name="ReturnShipping">
        <Property Name="CarrierName" Type="Edm.String" Nullable="false"/>
        <Property Name="CarrierAccountNumber" Type="Edm.String" Nullable="false"/>
      </ComplexType>
      <ComplexType Name="ShippingInformation">
        <Property Name="Name" Type="Edm.String" Nullable="false"/>
        <Property Name="Address" Type="Edm.String" Nullable="false"/>
      </ComplexType>
      <ComplexType Name="Package">
        <Property Name="CarrierName" Type="Edm.String" Nullable="false"/>
        <Property Name="TrackingNumber" Type="Edm.String" Nullable="false"/>
        <Property Name="DriveCount" Type="Edm.Int32" Nullable="true"/>
        <Property Name="ShipDate" Type="Edm.String" Nullable="true"/>
      </ComplexType>
      <ComplexType Name="Drive">
        <Property Name="DriveId" Type="Edm.String" Nullable="false"/>
        <Property Name="BitLockerKey" Type="Edm.String" Nullable="true"/>
        <Property Name="ManifestFile" Type="Edm.String" Nullable="true"/>
        <Property Name="ManifestHash" Type="Edm.String" Nullable="true"/>
        <Property Name="State" Type="Edm.String" Nullable="true"/>
        <Property Name="CopyStatus" Type="Edm.String" Nullable="true"/>
        <Property Name="PercentComplete" Type="Edm.Int32" Nullable="true"/>
        <Property Name="VerboseLogUri" Type="Edm.String" Nullable="true"/>
        <Property Name="ErrorLogUri" Type="Edm.String" Nullable="true"/>
        <Property Name="ManifestUri" Type="Edm.String" Nullable="true"/>
      </ComplexType>
      <ComplexType Name="ExportFragment">
        <Property Name="BlobListBlobPath" Type="Edm.String" Nullable="true"/>
        <Property Name="BlobList" Type="Microsoft.Cis.Services.ImportExport.Public.BlobList" Nullable="true"/>
      </ComplexType>
      <ComplexType Name="BlobList">
        <Property Name="BlobPath" Type="Collection(Edm.String)" Nullable="true"/>
        <Property Name="BlobPathPrefix" Type="Collection(Edm.String)" Nullable="true"/>
      </ComplexType>
      <ComplexType Name="AzureError">
        <Property Name="ExtendedCode" Type="Edm.String" Nullable="true"/>
        <Property Name="ExtendedInformation" Type="Edm.String" Nullable="true"/>
      </ComplexType>
    </Schema>
  </edmx:DataServices>
</edmx:Edmx>

See Also

Azure Import/Export Service Operations