AzureTemplate 1.7.0-beta.2

AzureTemplate 1.7.0-beta.2

×

Maintained by Microsoft Corporation.

AzureTemplate 1.7.0-beta.2

  • By
  • Azure SDK Mobile Team

{"payload":{"allShortcutsEnabled":false,"fileTree":{"sdk/template/AzureTemplate":{"items":[{"name":"AzureTemplate.xcodeproj","path":"sdk/template/AzureTemplate/AzureTemplate.xcodeproj","contentType":"directory"},{"name":"Source","path":"sdk/template/AzureTemplate/Source","contentType":"directory"},{"name":"AzureTemplate.podspec.json","path":"sdk/template/AzureTemplate/AzureTemplate.podspec.json","contentType":"file"},{"name":"CHANGELOG.md","path":"sdk/template/AzureTemplate/CHANGELOG.md","contentType":"file"},{"name":"Package.swift","path":"sdk/template/AzureTemplate/Package.swift","contentType":"file"},{"name":"README.md","path":"sdk/template/AzureTemplate/README.md","contentType":"file"}],"totalCount":6},"sdk/template":{"items":[{"name":"AzureTemplate","path":"sdk/template/AzureTemplate","contentType":"directory"},{"name":"ci.yml","path":"sdk/template/ci.yml","contentType":"file"}],"totalCount":2},"sdk":{"items":[{"name":"communication","path":"sdk/communication","contentType":"directory"},{"name":"core","path":"sdk/core","contentType":"directory"},{"name":"identity","path":"sdk/identity","contentType":"directory"},{"name":"template","path":"sdk/template","contentType":"directory"},{"name":"test","path":"sdk/test","contentType":"directory"}],"totalCount":5},"":{"items":[{"name":".github","path":".github","contentType":"directory"},{"name":"AzureSDK.xcworkspace","path":"AzureSDK.xcworkspace","contentType":"directory"},{"name":"eng","path":"eng","contentType":"directory"},{"name":"examples","path":"examples","contentType":"directory"},{"name":"jazzy","path":"jazzy","contentType":"directory"},{"name":"sdk","path":"sdk","contentType":"directory"},{"name":".gitignore","path":".gitignore","contentType":"file"},{"name":".swiftformat","path":".swiftformat","contentType":"file"},{"name":".swiftlint.yml","path":".swiftlint.yml","contentType":"file"},{"name":"CONTRIBUTING.md","path":"CONTRIBUTING.md","contentType":"file"},{"name":"LICENSE","path":"LICENSE","contentType":"file"},{"name":"Podfile","path":"Podfile","contentType":"file"},{"name":"README.md","path":"README.md","contentType":"file"},{"name":"SECURITY.md","path":"SECURITY.md","contentType":"file"}],"totalCount":14}},"fileTreeProcessingTime":15.888592,"foldersToFetch":[],"repo":{"id":123228625,"defaultBranch":"main","name":"azure-sdk-for-ios","ownerLogin":"Azure","currentUserCanPush":false,"isFork":false,"isEmpty":false,"createdAt":"2018-02-28T04:22:34.000Z","ownerAvatar":"https://avatars.githubusercontent.com/u/6844498?v=4","public":true,"private":false,"isOrgOwned":true},"codeLineWrapEnabled":false,"symbolsExpanded":false,"treeExpanded":true,"refInfo":{"name":"main","listCacheKey":"v0:1710974628.0","canEdit":false,"refType":"branch","currentOid":"6015c971c1593f3260ada5b15612515cf1e019a1"},"path":"sdk/template/AzureTemplate/README.md","currentUser":null,"blob":{"rawLines":null,"stylingDirectives":null,"colorizedLines":null,"csv":null,"csvError":null,"dependabotInfo":{"showConfigurationBanner":false,"configFilePath":null,"networkDependabotPath":"/Azure/azure-sdk-for-ios/network/updates","dismissConfigurationNoticePath":"/settings/dismiss-notice/dependabot_configuration_notice","configurationNoticeDismissed":null},"displayName":"README.md","displayUrl":"https://github.com/Azure/azure-sdk-for-ios/blob/main/sdk/template/AzureTemplate/README.md?raw=true","headerInfo":{"blobSize":"5.16 KB","deleteTooltip":"You must be signed in to make or propose changes","editTooltip":"You must be signed in to make or propose changes","ghDesktopPath":"https://desktop.github.com","isGitLfs":false,"onBranch":true,"shortPath":"98c43a7","siteNavLoginPath":"/login?return_to=https%3A%2F%2Fgithub.com%2FAzure%2Fazure-sdk-for-ios%2Fblob%2Fmain%2Fsdk%2Ftemplate%2FAzureTemplate%2FREADME.md","isCSV":false,"isRichtext":true,"toc":[{"level":1,"text":"Azure Template client library for iOS","anchor":"azure-template-client-library-for-ios","htmlText":"Azure Template client library for iOS"},{"level":2,"text":"Getting started","anchor":"getting-started","htmlText":"Getting started"},{"level":3,"text":"Prerequisites","anchor":"prerequisites","htmlText":"Prerequisites"},{"level":3,"text":"Install the library","anchor":"install-the-library","htmlText":"Install the library"},{"level":4,"text":"Add a package dependency with Swift Package Manager","anchor":"add-a-package-dependency-with-swift-package-manager","htmlText":"Add a package dependency with Swift Package Manager"},{"level":5,"text":"Xcode","anchor":"xcode","htmlText":"Xcode"},{"level":5,"text":"Swift CLI","anchor":"swift-cli","htmlText":"Swift CLI"},{"level":4,"text":"Integrate the client libraries with CocoaPods","anchor":"integrate-the-client-libraries-with-cocoapods","htmlText":"Integrate the client libraries with CocoaPods"},{"level":2,"text":"Key concepts","anchor":"key-concepts","htmlText":"Key concepts"},{"level":2,"text":"Examples","anchor":"examples","htmlText":"Examples"},{"level":2,"text":"Troubleshooting","anchor":"troubleshooting","htmlText":"Troubleshooting"},{"level":2,"text":"Next steps","anchor":"next-steps","htmlText":"Next steps"},{"level":2,"text":"Contributing","anchor":"contributing","htmlText":"Contributing"}],"lineInfo":{"truncatedLoc":"134","truncatedSloc":"94"},"mode":"file"},"image":false,"isCodeownersFile":null,"isPlain":false,"isValidLegacyIssueTemplate":false,"issueTemplate":null,"discussionTemplate":null,"language":"Markdown","languageID":222,"large":false,"planSupportInfo":{"repoIsFork":null,"repoOwnedByCurrentUser":null,"requestFullPath":"/Azure/azure-sdk-for-ios/blob/main/sdk/template/AzureTemplate/README.md","showFreeOrgGatedFeatureMessage":null,"showPlanSupportBanner":null,"upgradeDataAttributes":null,"upgradePath":null},"publishBannersInfo":{"dismissActionNoticePath":"/settings/dismiss-notice/publish_action_from_dockerfile","releasePath":"/Azure/azure-sdk-for-ios/releases/new?marketplace=true","showPublishActionBanner":false},"rawBlobUrl":"https://github.com/Azure/azure-sdk-for-ios/raw/main/sdk/template/AzureTemplate/README.md","renderImageOrRaw":false,"richText":"

Azure Template client library for iOS

\n

This package has no functionality and is only used for testing Engineering System deployments.

\n

Getting started

\n

Prerequisites

\n
    \n
  • The client library is written in modern Swift 5. Due to this, Xcode 10.2 or higher is required to use this library.
    • \n
\n

Install the library

\n

To install the Azure client libraries for iOS, we recommend you use\nSwift Package Manager.\nAs an alternative, you may also integrate the libraries using\nCocoaPods.

\n

Add a package dependency with Swift Package Manager

\n

The Swift Package Manager is a tool for managing the distribution of Swift code.\nIt’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.

\n

Xcode comes with built-in support for Swift Package Manager and source control accounts and makes it easy to leverage\navailable Swift packages. Use Xcode to manage the versions of package dependencies and make sure your project has the\nmost up-to-date code changes.

\n
Xcode
\n

To add the library to your application, follow the instructions in\nAdding Package Dependencies to Your App:

\n

In order to independently version packages with Swift Package Manager, we mirror the code from azure-sdk-for-ios into separate\nrepositories. Your Swift Package Manager-based app should target these repos instead of the azure-sdk-for-ios repo.

\n

With your project open in Xcode 11 or later, select File > Swift Packages > Add Package Dependency… Enter the\nclone URL of the Swift Package Manager mirror repository: https://github.com/Azure/SwiftPM-AzureTemplate.git\nand click Next. For the version rule, specify the exact version or version range you wish to use with your application and\nclick Next. Finally, place a checkmark next to the library, ensure your application target is selected in the Add to target\ndropdown, and click Finish.

\n
Swift CLI
\n

To add the library to your application, follow the example in\nImporting Dependencies:

\n

Open your project's Package.swift file and add a new package dependency to your project's dependencies section,\nspecifying the clone URL of this repository and the version specifier you wish to use:

\n
https://github.com/Azure/SwiftPM-AzureTemplate.git", from: "1.7.0-beta.1")\n ],\">
// swift-tools-version:5.3\n    dependencies: [\n        …\n        .package(name: \"AzureTemplate\", url: \"https://github.com/Azure/SwiftPM-AzureTemplate.git\", from: \"1.7.0-beta.1\")\n    ],
\n

Next, for each target that needs to use the library, add it to the target's array of dependencies:

\n
¨C11C
\n

Integrate the client libraries with CocoaPods

\n

CocoaPods is a dependency manager for Objective C and Swift projects. You can install it with\nthe following command:

\n
¨C12C
\n¨C13C\n

To integrate one or more client libraries into your project using CocoaPods, specify them in your\nPodfile, providing the version specifier you wish to use. To\nensure compatibility when using multiple client libraries in the same project, use the same version specifier for all\nAzure SDK client libraries within the project:

\n
¨C14C
\n

Then, run the following command:

\n
¨C15C
\n

Key concepts

\n

Not applicable.

\n

Examples

\n

Not applicable.

\n

Troubleshooting

\n

Not applicable.

\n

Next steps

\n

Explore and install\navailable Azure SDK libraries.

\n

Contributing

\n

This project welcomes contributions and suggestions. All code contributions should be made in the [Azure SDK for iOS]\n(https://github.com/Azure/azure-sdk-for-ios) repository.

\n

Most contributions require you to agree to a Contributor License\nAgreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For\ndetails, visit https://cla.microsoft.com.

\n

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate\nthe PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to\ndo this once across all repositories using our CLA.

\n

This project has adopted the Microsoft Open Source Code of Conduct.\nFor more information see the Code of Conduct FAQ or contact\n[email protected] with any additional questions or comments.

\n

\"Impressions\"

\n
","renderedFileInfo":null,"shortPath":null,"symbolsEnabled":true,"tabSize":8,"topBannersInfo":{"overridingGlobalFundingFile":false,"globalPreferredFundingPath":null,"showInvalidCitationWarning":false,"citationHelpUrl":"https://docs.github.com/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files","actionsOnboardingTip":null},"truncated":false,"viewable":true,"workflowRedirectUrl":null,"symbols":{"timed_out":false,"not_analyzed":false,"symbols":[{"name":"Azure Template client library for iOS","kind":"section_1","ident_start":2,"ident_end":39,"extent_start":0,"extent_end":5287,"fully_qualified_name":"Azure Template client library for iOS","ident_utf16":{"start":{"line_number":0,"utf16_col":2},"end":{"line_number":0,"utf16_col":39}},"extent_utf16":{"start":{"line_number":0,"utf16_col":0},"end":{"line_number":134,"utf16_col":0}}},{"name":"Getting started","kind":"section_2","ident_start":140,"ident_end":155,"extent_start":137,"extent_end":3851,"fully_qualified_name":"Getting started","ident_utf16":{"start":{"line_number":4,"utf16_col":3},"end":{"line_number":4,"utf16_col":18}},"extent_utf16":{"start":{"line_number":4,"utf16_col":0},"end":{"line_number":99,"utf16_col":0}}},{"name":"Prerequisites","kind":"section_3","ident_start":161,"ident_end":174,"extent_start":157,"extent_end":294,"fully_qualified_name":"Prerequisites","ident_utf16":{"start":{"line_number":6,"utf16_col":4},"end":{"line_number":6,"utf16_col":17}},"extent_utf16":{"start":{"line_number":6,"utf16_col":0},"end":{"line_number":9,"utf16_col":0}}},{"name":"Install the library","kind":"section_3","ident_start":298,"ident_end":317,"extent_start":294,"extent_end":3851,"fully_qualified_name":"Install the library","ident_utf16":{"start":{"line_number":9,"utf16_col":4},"end":{"line_number":9,"utf16_col":23}},"extent_utf16":{"start":{"line_number":9,"utf16_col":0},"end":{"line_number":99,"utf16_col":0}}},{"name":"Add a package dependency with Swift Package Manager","kind":"section_4","ident_start":594,"ident_end":645,"extent_start":589,"extent_end":2950,"fully_qualified_name":"Add a package dependency with Swift Package Manager","ident_utf16":{"start":{"line_number":15,"utf16_col":5},"end":{"line_number":15,"utf16_col":56}},"extent_utf16":{"start":{"line_number":15,"utf16_col":0},"end":{"line_number":65,"utf16_col":0}}},{"name":"Xcode","kind":"section_5","ident_start":1163,"ident_end":1168,"extent_start":1157,"extent_end":2133,"fully_qualified_name":"Xcode","ident_utf16":{"start":{"line_number":24,"utf16_col":6},"end":{"line_number":24,"utf16_col":11}},"extent_utf16":{"start":{"line_number":24,"utf16_col":0},"end":{"line_number":38,"utf16_col":0}}},{"name":"Swift CLI","kind":"section_5","ident_start":2139,"ident_end":2148,"extent_start":2133,"extent_end":2950,"fully_qualified_name":"Swift CLI","ident_utf16":{"start":{"line_number":38,"utf16_col":6},"end":{"line_number":38,"utf16_col":15}},"extent_utf16":{"start":{"line_number":38,"utf16_col":0},"end":{"line_number":65,"utf16_col":0}}},{"name":"Integrate the client libraries with CocoaPods","kind":"section_4","ident_start":2955,"ident_end":3000,"extent_start":2950,"extent_end":3851,"fully_qualified_name":"Integrate the client libraries with CocoaPods","ident_utf16":{"start":{"line_number":65,"utf16_col":5},"end":{"line_number":65,"utf16_col":50}},"extent_utf16":{"start":{"line_number":65,"utf16_col":0},"end":{"line_number":99,"utf16_col":0}}},{"name":"Key concepts","kind":"section_2","ident_start":3854,"ident_end":3866,"extent_start":3851,"extent_end":3885,"fully_qualified_name":"Key concepts","ident_utf16":{"start":{"line_number":99,"utf16_col":3},"end":{"line_number":99,"utf16_col":15}},"extent_utf16":{"start":{"line_number":99,"utf16_col":0},"end":{"line_number":103,"utf16_col":0}}},{"name":"Examples","kind":"section_2","ident_start":3888,"ident_end":3896,"extent_start":3885,"extent_end":3915,"fully_qualified_name":"Examples","ident_utf16":{"start":{"line_number":103,"utf16_col":3},"end":{"line_number":103,"utf16_col":11}},"extent_utf16":{"start":{"line_number":103,"utf16_col":0},"end":{"line_number":107,"utf16_col":0}}},{"name":"Troubleshooting","kind":"section_2","ident_start":3918,"ident_end":3933,"extent_start":3915,"extent_end":3952,"fully_qualified_name":"Troubleshooting","ident_utf16":{"start":{"line_number":107,"utf16_col":3},"end":{"line_number":107,"utf16_col":18}},"extent_utf16":{"start":{"line_number":107,"utf16_col":0},"end":{"line_number":111,"utf16_col":0}}},{"name":"Next steps","kind":"section_2","ident_start":3955,"ident_end":3965,"extent_start":3952,"extent_end":4105,"fully_qualified_name":"Next steps","ident_utf16":{"start":{"line_number":111,"utf16_col":3},"end":{"line_number":111,"utf16_col":13}},"extent_utf16":{"start":{"line_number":111,"utf16_col":0},"end":{"line_number":116,"utf16_col":0}}},{"name":"Contributing","kind":"section_2","ident_start":4108,"ident_end":4120,"extent_start":4105,"extent_end":5287,"fully_qualified_name":"Contributing","ident_utf16":{"start":{"line_number":116,"utf16_col":3},"end":{"line_number":116,"utf16_col":15}},"extent_utf16":{"start":{"line_number":116,"utf16_col":0},"end":{"line_number":134,"utf16_col":0}}}]}},"copilotInfo":null,"copilotAccessAllowed":false,"csrf_tokens":{"/Azure/azure-sdk-for-ios/branches":{"post":"M-CYei06cfRh66uFz3QQmnncLtdnMCZeixwlJP9Zqvp6d0RC1vgBr5PfPsfXF25eDsByGdS3E73Z8lVNLIRsOg"},"/repos/preferences":{"post":"qFKCeK2niw1ot7eMOFkOW6ef9Fnr998kgR13ncdyuqA_TVW1gZqX-V-ADpOU51wpF3fADz0AtOYG8VeZ48ZKfg"}}},"title":"azure-sdk-for-ios/sdk/template/AzureTemplate/README.md at main · Azure/azure-sdk-for-ios"}